Docs For Class INFA_CMS_MENU

Interface INFA_CMS_MENU_NODE

Description

openCSP interface INFA_CMS_MENU_NODE

author: Peter Krebs <pitlinz@users.sourceforge.net>
version: $Id: INFA_CMS_MENU_NODE.phpclass,v 1.12 2008/12/03 09:47:56 pitlinz Exp $
since: pk-13.06.2008
project: Open CSP-Management
license: GNU Public License

Located in /cms/menu/INFA_CMS_MENU_NODE.phpclass (line 33)

Method Summary

int checkShowDate ([ $debug = False])

boolean curUserCanAddChild ([boolean $debug = False])

boolean curUserCanAddPage ([boolean $debug = False])

boolean curUserCanDelete ([boolean $debug = False])

boolean curUserCanEdit ([boolean $debug = False])

boolean curUserCanOpen ([boolean $debug = False])

array getChildrenList ([boolean $useCache = True], [boolean $debug = False], [boolean $filtered = False])

CMS_PAGE &getCurrentPage ([boolean $goDown = False], [boolean $online = True], [array $xtraConditions = Null], [boolean $debug = False])

int getId ()

string getKey ()

string getLinkUrl ([array $valArr = array()], [boolean $debug = False])

CMS_PROJECT &getMyProject ([boolean $debug = False], [boolean $forceObj = True], [boolean $setAsCurrent = False])

int getOrderNr ()

CMS_MENU_NODE &getParentObj ([boolean $useCache = True], [boolean $debug = False])

array getRootPath ([boolean $useCache = True], [boolean $debug = False])

int getTemplateId ([boolean $debug = False])

string getTitle ([int $langId = 0], [boolean $debug = False])

CMS_MENU &getTree ([boolean $useCache = True], [boolean $debug = False], [boolean $checkParent = True])

boolean hasChildren ([boolean $debug = False])

boolean hasEditablePages ([boolean $debug = False])

boolean isCurrent ([boolean $debug = False])

boolean isEditable ([boolean $debug = False])

boolean isToEcho ([boolean $debug = False])

bool isToShow ([boolean $checkDate = True], [boolean $checkGroup = True], [boolean $debug = False], [boolean $checkShow = True])

void setAsCurrent ([boolean $debug = False])

void setOrderNr (int $aOrderNr)

void setParentObj ( &$aParent, CMS_MENU_NODE $aParent)

void setTreeObj ( &$aTree, CMS_MENU $aTree)

Methods

checkShowDate (line 233)

checks if the menu is to show from date

return values are:

1: yes
0: showtill is outdate
-2: showfrom is not reached

int checkShowDate ([ $debug = False])

$debug

curUserCanAddChild (line 347)

returns if the current user can add a childmenu

boolean curUserCanAddChild ([boolean $debug = False])

boolean $debug

curUserCanAddPage (line 357)

returns if the current user can add a page

boolean curUserCanAddPage ([boolean $debug = False])

boolean $debug

curUserCanDelete (line 367)

returns if the current user can delete the menu

boolean curUserCanDelete ([boolean $debug = False])

boolean $debug

curUserCanEdit (line 379)

returns if the current user can edit the menu

since: pk-06-11-06

boolean curUserCanEdit ([boolean $debug = False])

boolean $debug

curUserCanOpen (line 337)

returns if the current user can open the menu

boolean curUserCanOpen ([boolean $debug = False])

boolean $debug

getChildrenList (line 198)

returns a array of pointers to the child objects

if filtered $this->myFilterArr is used to check the child

array getChildrenList ([boolean $useCache = True], [boolean $debug = False], [boolean $filtered = False])

boolean $useCache
boolean $debug
boolean $filtered

getCurrentPage (line 312)

returns the current Page this is the first page found and the user has rights to show

CMS_PAGE &getCurrentPage ([boolean $goDown = False], [boolean $online = True], [array $xtraConditions = Null], [boolean $debug = False])

boolean $goDown: (check children if the node has no page to show)
boolean $online: (check if the page is online if false all pages are returned)
array $xtraConditions: (array of columns to check to)
boolean $debug

getId (line 78)

returns the menu id

access: public

int getId ()

getKey (line 71)

returns the menu key

the menu key is a '-' seperated string where the 1st part is the ocsp MEN_ID

access: public

string getKey ()

getLinkUrl (line 118)

returns the link url

access: public

string getLinkUrl ([array $valArr = array()], [boolean $debug = False])

array $valArr
boolean $debug

getMyProject (line 215)

returns the Project Object

CMS_PROJECT &getMyProject ([boolean $debug = False], [boolean $forceObj = True], [boolean $setAsCurrent = False])

boolean $debug
boolean $forceObj: (if false no new object will be instanciated)
boolean $setAsCurrent: (if true call $this->setAsCurrent())

getOrderNr (line 95)

returns the orderNr

access: public

int getOrderNr ()

getParentObj (line 153)

returns the parent object or null if parent is root

CMS_MENU_NODE &getParentObj ([boolean $useCache = True], [boolean $debug = False])

boolean $useCache
boolean $debug

getRootPath (line 169)

returns a array back to the root

array getRootPath ([boolean $useCache = True], [boolean $debug = False])

boolean $useCache
boolean $debug

getTemplateId (line 323)

returns the template id set in menu or project

since: pk-08-06-16
access: public

int getTemplateId ([boolean $debug = False])

boolean $debug

getTitle (line 87)

access: public

string getTitle ([int $langId = 0], [boolean $debug = False])

int $langId
boolean $debug

getTree (line 134)

returns myTree object

CMS_MENU &getTree ([boolean $useCache = True], [boolean $debug = False], [boolean $checkParent = True])

boolean $useCache
boolean $debug
boolean $checkParent: (if false $this->getParentObj is not called)

hasChildren (line 182)

returns if the node has children

access: public

boolean hasChildren ([boolean $debug = False])

boolean $debug

hasEditablePages (line 294)

return if the menu type can have editable pages

if not the menu generates it's page object himself users are not able to add pages to the menu

since: pk-08-12-03
access: public

boolean hasEditablePages ([boolean $debug = False])

boolean $debug

isCurrent (line 266)

checks if the menu is the current menu

boolean isCurrent ([boolean $debug = False])

boolean $debug

isEditable (line 280)

returns if the node is editable

access: public

boolean isEditable ([boolean $debug = False])

boolean $debug

isToEcho (line 256)

returns if the object is to echo in the tree when creating the html-code or only children are to show instead of the node

boolean isToEcho ([boolean $debug = False])

boolean $debug

isToShow (line 245)

checks if the node is on

bool isToShow ([boolean $checkDate = True], [boolean $checkGroup = True], [boolean $debug = False], [boolean $checkShow = True])

boolean $checkDate
boolean $checkGroup
boolean $debug
boolean $checkShow

setAsCurrent (line 272)

sets the node as current menu node

void setAsCurrent ([boolean $debug = False])

boolean $debug

setOrderNr (line 103)

sets the OrderNr

access: public

void setOrderNr (int $aOrderNr)

int $aOrderNr

setParentObj (line 159)

sets the parent object

void setParentObj ( &$aParent, CMS_MENU_NODE $aParent)

CMS_MENU_NODE $aParent
&$aParent

setTreeObj (line 142)

sets the tree object

void setTreeObj ( &$aTree, CMS_MENU $aTree)

CMS_MENU $aTree
&$aTree

Documentation generated on Thu, 08 Jan 2009 17:44:25 +0100 by phpDocumentor 1.4.0a2