MCMSCat

class MCMSCat extends MCMSDataObject

Třída reprezentující adresář ve stromové struktuře

bool function SetValue( key $key, $value [ , bool $incedit ] [ , bool $setedate ] )

nastaví hodnotu sloupce
$key: jméno nebo klíč sloupce
$value: hodnota
$incedit: určuje, zda má být u položky zvýšeno počítadlo úprav [ 0 ]
$setedate: určuje, zda má být nastaven čas změny [ 1 ]

bool function SetValues( array $vals [ , bool $incedit ] [ , bool $setedate ] )

nastaví jednu nebé více hodnot
$vals: asociativní pole klíč=>hodnota
$incedit: určuje, zda má být u položky zvýšeno počítadlo úprav [ 0 ]
$setedate: určuje, zda má být nastaven čas změny [ 1 ]

function SetTempValue( key $key, $value )

přiřadí dočasnou hodnotu k položce (která se neukládá)
$key: název
$value: hodnota

variant function Value( key $key [ , bool $format ] [ , string $defaultvalue='' ] )

vrátí hodnotu
$key: jméno nebo klíč sloupce
$format: naformátovat výstup [ 0 ]
$defaultvalue='': výchozí hodnota

int function Index()

vrátí index

key function UType()

vrátí index uživatelského typu adresáře

int function Pos()

vrátí pozici v adresáři

int function Owner()

vrátí index nadřazeného adresáře

int function SiteOwner()

vrátí index vlastníka ze stránek

key function Cat()

vrátí index nadřazeného adresáře

key function AllowedTopParent()

vrátí maximálního možného rodiče (hlídaného pouze v administračním rozhraní)

bool function Show()

určuje zda je adresář zobrazen

key function Picture()

vrátí index připojeného obrázku

string function GetPictureLink( [ string $param='' ] [ , bool $iamp ] )

vrátí odkaz na připojený obrázek
$param='': dodatečný parametr odkazu
$iamp: určuje, zda v odkazu má být místo znaku & entita & [ 1 ]

string function Caption()

vrátí název adresáře

string function Description()

vrátí popis adresáře

string function Note()

vrátí poznámku

key function Type( [ bool $allowauto ] )

vrátí typ
$allowauto: určuje zda má být určen typ v případě nastaveného typu na automatický [ 1 ]

string function GetLink( [ string $extraparam='' ] [ , bool $iamp ] [ , string $aliasprefix='' ] [ , string $aliaspostfix='' ] , $allowautoalias )

vrátí relativní odkaz na skript otevírající adresář
$extraparam='': dodatečný parametr odkazu
$iamp: určuje, zda v odkazu má být místo znaku & entita & [ 1 ]
$aliasprefix='': prefix u aliasu
$aliaspostfix='': postfix u aliasu
$allowautoalias:

function GetCat()

MCMSCat function FindSubCat( string $nazev )

vrátí první nalezený podadresář podle názvu
$nazev: hledaný název

MCMSCat function GetParent( [ key $incat=false ] )

vrátí nadřazený adresář
$incat=false: určuje ze kterého adresáře je nadřazený adresář [ jen o stupeň výše ]

MCMSCats function GetParents( [ key $topcat ] )

vrací seznam adresářů od nejvyššího po přímý nadřezený adresář
$topcat: do úrovně [ plocha ]

MCMSCats function GetParentsVector( [ key $topcat ] )

vrací seznam adresářů od nejvyššího po přímý nadřezený adresář
$topcat: do úrovně [ plocha ]

bool function IsParent( key $node )

vrátí zda je adresář nadřazený
$node: index nebo konstanta

MCMSRSS function GetRSS()

vrátí objekt třídy MCMSRSS s obsahem adresáře

MCMSXMLExport function GetXML()

vrátí objekt třídy MCMSXMLExport s obsahem adresáře

MCMSGallery function GetGallery()

vrátí objekt třídy MCMSGallery s obsahem adresáře

string function FullPath( [ string $sep ] [ , key $topcat ] [ , bool $links ] , string $includetopcat, $linkparam='' )

vrací úplnou textovou cestu k adresáři s oddělovači (např. pro generování orientační lišty)
$sep: separátor včetně mezer [ " \ " ]
$topcat: do úrovně [ plocha ]
$links: včetně odkazů na jednotlivé adresáře [ 0 ]
$includetopcat: parametry nebo true pro odkaz na první položku v adresáři
$linkparam='':

array function GetSubCatsVector( [ bool $show ] [ , bool $tree ] [ , bool $top ] )

vrací vektor se seznamem podadresářů
$show: jen zobrazené [ false ]
$tree: celý strom (včetně podadresářů podadresářů) [ true ]
$top: včetně kořenového adresáře [ true ]

int function GetSubCatsCount( [ bool $show ] [ , bool $tree ] )

vrací počet podadresářů
$show: jen zobrazené [ false ]
$tree: celý strom (včetně podadresářů podadresářů) [ false ]

int function GetItemsCount( [ bool $tree ] [ , bool $published ] )

vrací počet položek v adresáři
$tree: celý strom (včetně podadresářů podadresářů) [ false ]
$published: jen publikované (stránky)

int function ReadedCount()

vrátí počet přečtení

function View_Counter_Add()

navyšuje počítadlo přečtení
ZASTARALÉ - bude odstraněno nebo nahrazeno

bool function IsEmpty( [ bool $inccat ] [ , bool $subcats ] )

vrací zda je adresář prázdný
$inccat: brát v potaz i prázdné adresáře jako obsah [ 0 ]
$subcats: brát v potaz i podadresáře [ 1 ]

MCMSItems function GetItems( [ key $type ] [ , array $sortkeys ] [ , int $limitfrom ] [ , int $limitcount ] )

vrací seznam položek v adresáři
$type: typ položek [ DTYPE_ALL ]
$sortkeys: řazení [ výchozí řazení ]
$limitfrom: od řádku [ 0 ]
$limitcount: počet řádků
Viz. MCMSSite:GetItems

MCMSCats function GetSubCats( key $sortkeys [ , array $limitfrom ] [ , int $limitcount ] )

vrací seznam podadresářů
$sortkeys: index adresáře, def. konstanta nebo vektor se seznamem adresářů
$limitfrom: řazení [ výchozí řazení ]
$limitcount: od řádku [ 0 ]
Viz. MCMSSite:GetSubCats

string function Icon()

vrací ikonu v systému

string function UserIcon()

vrací uživatelskou ikonu v systému

datetime function InsertDate()

vrací datum vložení

datetime function EditDate()

vrací datum poslední úpravy

datetime function LastModified( [ bool $subcats ] )

vrací datum poslední úpravy obsahu
$subcats: včetně podadresářů [ true ]

datetime function GetLastInsertDate( [ bool $subcats ] )

vrací datum poslední vložení obsahu
$subcats: včetně podadresářů [ true ]

MCMSExport function GetExport()

vrací objekt reprezentující export adresáře

MCMSImport function GetImport()

vrací objekt reprezentující import adresáře

bool function DeleteCat()

odstraní adresář

bool function DeleteAliases()

odstraní aliasy k adresáři

bool function EmptyCat( [ bool $withsubcats=false ] [ , bool $forcedel=false ] )

odstraní obsah adresáře
$withsubcats=false: včetně podadresářů [ false ]
$forcedel=false: včetně podadresářů [ false ]

bool function MoveItem( key $cat )

přesunout adresář
$cat: cílový adresář

bool function CopyCat( key $cat )

kopírovat adresář
$cat: cílový adresář

MCMSItem function History( [ int $hist ] )

vrací položku z historie
$hist: index verze

bool function CopyToHistory()

uloží aktuální verzi do historie (otevřená položka musí být aktuální)

bool function RestoreFromHistory()

obnoví starší verzi z historie (otevřená položka musí z historie)

int function HistorySize()

vrací počet verzí uložených v historii

function UserSort( $sdefault )

$sdefault:

function UserSortDir( $sdefault )

$sdefault:

int function LastItemPos()

vrací hodnotu poslední pozice položky v adresáři

int function LastCatPos()

vrací hodnotu poslední pozice podadresáře v adresáři

function ChangePos( int $pos, $before )

změní pozici v seznamu (řazení dle pozice)
$pos: pozice
$before:

function ResetPos()

vynuluje pozici (výchozí řazení)

function ClassType()

function ClassName()