Class PGP_CMS_MENU_NODE

Description
Description | Vars (details) | Methods (details) Constants (details)

Implements interfaces:

openCSP class PGP_CMS_MENU_NODE

Located in /products/PGP_CMS_MENU_NODE.phpclass (line 39) 

OCSP_OBJ
   |
   --PGP_CMS_MENU_NODE
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
CLASS_SRC_FILE = __FILE__
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
double $childrenPopulateTS
array $myChildren
PGP_CMS_MENU $myMenu
PGP_CMS_MENU_NODE $myParent
PRO_GROUP $myProGroup
int $mySortOrder
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
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])
array getDBVal ([boolean $setFields = False], [boolean $debug = False], [boolean $withObjVars = True])
int getId ()
string getKey ()
string getLinkUrl ([array $valArr = array()], [boolean $debug = False])
PGP_CMS_MENU &getMenu ()
CMS_PROJECT &getMyProject ([boolean $debug = False], [boolean $forceObj = True], [boolean $setAsCurrent = False])
int getOrderNr ()
CMS_MENU_NODE &getParentObj ([boolean $useCache = True], [boolean $debug = False])
PRO_GROUP getProductGroup ([boolean $debug = False])
array(); getProducts ([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 populateChildren ([boolean $useCache = True], [boolean $debug = False])
void setAsCurrent ([boolean $debug = False])
void setMenu ( &$aMenuNode, PGP_CMS_MENU $aMenuNode;)
void setOrderNr (int $aOrderNr)
void setParentObj ( &$aParent, PGP_CMS_MENU_NODE $aParent)
void setProductGroup ( &$aProdGroup, PRO_GROUP $aProdGroup)
void setTreeObj ( &$aTree, CMS_MENU $aTree)
Variables
Description | Vars (details) Constants (details) | Methods (details)
double $childrenPopulateTS = 0 (line 110)

children populate time stamp

if set within time() - max_execution_time the children have been already populate no need to redo

  • access: protected
array $myChildren = array() (line 88)

children array

  • access: protected
PGP_CMS_MENU $myMenu = Null (line 67)
  • access: protected
PGP_CMS_MENU_NODE $myParent = Null (line 81)

parent object

  • access: protected
PRO_GROUP $myProGroup = Null (line 74)

product group assigned to the menu node

  • access: protected
int $mySortOrder = 0 (line 100)

sort order number

this is to avoid overwriting product group ordering when resorting the menu

  • access: protected

Inherited Variables

Inherited from OCSP_OBJ

OCSP_OBJ::$global_currentUser
 OCSP_OBJ::$global_defaultDBObj_read
 OCSP_OBJ::$global_defaultDBObj_write
 OCSP_OBJ::$myDBObj
 OCSP_OBJ::$staticClassVars
Methods
Description | Vars (details) Methods (details)
checkShowDate (line 515)

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 775)

returns if the current user can add a childmenu

boolean curUserCanAddChild ([boolean $debug = False])
  • boolean $debug
curUserCanAddPage (line 788)

returns if the current user can add a page

boolean curUserCanAddPage ([boolean $debug = False])
  • boolean $debug
curUserCanDelete (line 801)

returns if the current user can delete the menu

boolean curUserCanDelete ([boolean $debug = False])
  • boolean $debug
curUserCanEdit (line 816)

returns if the current user can edit the menu

  • since: pk-06-11-06
boolean curUserCanEdit ([boolean $debug = False])
  • boolean $debug
curUserCanOpen (line 751)

returns if the current user can open the menu

boolean curUserCanOpen ([boolean $debug = False])
  • boolean $debug
getChildrenList (line 442)

returns a array of pointers to the child objects

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

  • access: public
array getChildrenList ([boolean $useCache = True], [boolean $debug = False], [boolean $filtered = False])
  • boolean $useCache
  • boolean $debug
  • boolean $filtered
getCurrentPage (line 719)

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
getDBVal (line 203)

returns the database values of the menu and the product group

  • access: public
array getDBVal ([boolean $setFields = False], [boolean $debug = False], [boolean $withObjVars = True])
  • boolean $setFields
  • boolean $debug
  • boolean $withObjVars
getId (line 149)

returns the menu id

  • access: public
int getId ()
getKey (line 129)

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 242)

returns the link url

  • access: public
string getLinkUrl ([array $valArr = array()], [boolean $debug = False])
  • array $valArr
  • boolean $debug
getMenu (line 218)

returns the cms menu node

  • access: public
PGP_CMS_MENU &getMenu ()
getMyProject (line 494)

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 174)

returns the orderNr

  • access: public
int getOrderNr ()
getParentObj (line 352)

returns the parent object or null if parent is root

CMS_MENU_NODE &getParentObj ([boolean $useCache = True], [boolean $debug = False])
  • boolean $useCache
  • boolean $debug
getProductGroup (line 285)

returns the product group of the node

  • access: public
PRO_GROUP getProductGroup ([boolean $debug = False])
  • boolean $debug
getProducts (line 307)

returns an array with the products

  • access: public
array(); getProducts ([boolean $debug = False])
  • boolean $debug
getRootPath (line 391)

returns a array back to the root

array getRootPath ([boolean $useCache = True], [boolean $debug = False])
  • boolean $useCache
  • boolean $debug
getTemplateId (line 734)

returns the template id set in menu or project

  • access: public
int getTemplateId ([boolean $debug = False])
  • boolean $debug
getTitle (line 161)
  • access: public
string getTitle ([int $langId = 0], [boolean $debug = False])
  • int $langId
  • boolean $debug
getTree (line 326)

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 418)

returns if the node has children

  • access: public
boolean hasChildren ([boolean $debug = False])
  • boolean $debug
hasEditablePages (line 698)

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 654)

checks if the menu is the current menu

boolean isCurrent ([boolean $debug = False])
  • boolean $debug
isEditable (line 681)

returns if the node is editable

  • access: public
boolean isEditable ([boolean $debug = False])
  • boolean $debug
isToEcho (line 641)

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 559)

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
populateChildren (line 459)

populates the children out of the product group

  • access: protected
void populateChildren ([boolean $useCache = True], [boolean $debug = False])
  • boolean $useCache
  • boolean $debug
setAsCurrent (line 670)

sets the node as current menu node

void setAsCurrent ([boolean $debug = False])
  • boolean $debug
setMenu (line 228)

sets the cms menu node

  • access: public
void setMenu ( &$aMenuNode, PGP_CMS_MENU $aMenuNode;)
setOrderNr (line 189)

sets the OrderNr

  • access: public
void setOrderNr (int $aOrderNr)
  • int $aOrderNr
setParentObj (line 378)

sets the parent object

void setParentObj ( &$aParent, PGP_CMS_MENU_NODE $aParent)
setProductGroup (line 295)

sets the product group of the node

  • access: public
void setProductGroup ( &$aProdGroup, PRO_GROUP $aProdGroup)
setTreeObj (line 338)

sets the tree object

void setTreeObj ( &$aTree, CMS_MENU $aTree)

Inherited Methods

Inherited From OCSP_OBJ

OCSP_OBJ::castObj()
OCSP_OBJ::cloneMe()
OCSP_OBJ::currentUser()
OCSP_OBJ::dbConnect()
OCSP_OBJ::defaultDBObj()
OCSP_OBJ::defaultReadDBObj()
OCSP_OBJ::defaultWriteDBObj()
OCSP_OBJ::getConf()
OCSP_OBJ::getDBObj()
OCSP_OBJ::get_myClassConstant()
OCSP_OBJ::get_myObject_vars()
OCSP_OBJ::get_mySourceFile()
OCSP_OBJ::isConnected()
OCSP_OBJ::isMultiByteStr()
OCSP_OBJ::isUTF8()
OCSP_OBJ::setConf()
OCSP_OBJ::setDBObj()
OCSP_OBJ::set_myObject_vars()
OCSP_OBJ::set_myVarsFrom()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)
CLASS_SRC_FILE = __FILE__ (line 48)

Inherited Constants

Inherited from OCSP_OBJ

OCSP_OBJ::CLASS_SRC_FILE

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