openCSP class CMS_MENU

singleton object

• author: Peter Krebs <pitlinz@users.sourceforge.net>
• version: $Id: CMS_MENU.phpclass,v 1.10 2008/11/24 23:30:33 pitlinz Exp $
• since: pk-16.06.2008
• project: Open CSP-Management
• license: GNU Public License

Located in /cms/menu/CMS_MENU.phpclass (line 41)

OCSP_OBJ
   |
   --DBMS_TABLEOBJ
      |
      --DBMS_TREE
         |
         --CMS_MENU

static mixed $loadedMenus = array() (line 63)

• staticvar: CMS_MENU $myInstance:
• access: protected

array $childNodes = array() (line 118)

array of child nodes

array(key = array($key => node))

• access: protected

int $menRootId = 0 (line 141)

the root Id in T_CMS_MENU

• access: protected

array $myFirstLevelChildren = array() (line 125)

array of the first level children

• access: protected

array $myNodes = array() (line 109)

• var: myNodes
• access: protected

CMS_PROJECT $myProject = Null (line 132)

project object

• access: protected

Inherited Variables

Inherited from DBMS_TREE

DBMS_TREE::$childClassColumn
DBMS_TREE::$myChildClass
DBMS_TREE::$myChildKeys
DBMS_TREE::$myChildren
DBMS_TREE::$myChildrenPopulateTS
DBMS_TREE::$myFilterArr
DBMS_TREE::$myGlobalTreeKey
DBMS_TREE::$myIdFld
DBMS_TREE::$myLink
DBMS_TREE::$myParentFld
DBMS_TREE::$myRootId
DBMS_TREE::$mySortFld

Inherited from DBMS_TABLEOBJ

DBMS_TABLEOBJ::$autoIncFld
DBMS_TABLEOBJ::$dbTableDefinitions
DBMS_TABLEOBJ::$frmPostSubOjects
DBMS_TABLEOBJ::$hasObjVals
DBMS_TABLEOBJ::$initTS
DBMS_TABLEOBJ::$myCacheTS
DBMS_TABLEOBJ::$myFields
DBMS_TABLEOBJ::$myKeys
DBMS_TABLEOBJ::$myLinkedTableRows
DBMS_TABLEOBJ::$myMode
DBMS_TABLEOBJ::$myObjVals
DBMS_TABLEOBJ::$myObjValsPopulateTS
DBMS_TABLEOBJ::$myTable
DBMS_TABLEOBJ::$objError
DBMS_TABLEOBJ::$objErrorMsg
DBMS_TABLEOBJ::$populateTS
DBMS_TABLEOBJ::$staticClassVars
DBMS_TABLEOBJ::$valChangeTS

Inherited from OCSP_OBJ

OCSP_OBJ::$global_currentUser
OCSP_OBJ::$global_defaultDBObj_read
OCSP_OBJ::$global_defaultDBObj_write
OCSP_OBJ::$myDBObj

static getAvailableNodeClasses (line 89)

returns an array with all available node classes

• access: public

array getAvailableNodeClasses ()

static getInstance (line 73)

returns the singleton instance

• access: public

OCSP_MENU &getInstance ( $projId)

• $projId

addNode (line 314)

• access: public

void addNode ( &$aNode)

• &$aNode

getChildNodes (line 402)

returns previously set children array

• access: public

array getChildNodes (string $aKey, boolean $debug)

• string $aKey
• boolean $debug

getChildrenList (line 434)

returns a array of pointers to the child objects

array getChildrenList ([bool $debug = False], [bool $filtered = False])

• bool $debug
• bool $filtered

---

Redefinition of:

DBMS_TREE::getChildrenList()

returns a array of pointers to the child objects

getMyProject (line 154)

returns the project object

• access: public

CMS_PROJECT &getMyProject (boolean $debug)

• boolean $debug

getNode (line 201)

returns the menu node with key $aKey

a key can be seperated with '-'

• access: public

CMS_MENU_NODE &getNode (mixed $aKey, [boolean $forceObj = False], [boolean $debug = False])

• mixed $aKey: (
• boolean $forceObj
• boolean $debug

---

Redefinition of:

DBMS_TREE::getNode()

get a node if the

getNodeFromEnv (line 329)

returns the menu node from $_GET

• access: public

CMS_MENU_NODE &getNodeFromEnv ([boolean $debug = False])

• boolean $debug

getNodeFromRow (line 362)

faktories a node form a dbRow

• access: public

CMS_MENU_NODE &getNodeFromRow (array $nodeRow, [boolean $forceOverload = False], [boolean $debug = False])

• array $nodeRow
• boolean $forceOverload
• boolean $debug

getProjId (line 166)

returns the project Id

• todo: ask tree nodes
• access: public

int getProjId ()

getRootPath (line 497)

returns an array of pointers to the elements till root with all

in case of an error false is return (use '===' type equal )

• return: array of pointers to nodes key=DBMS_TREE_NODE::getId()

array getRootPath (mixed $aNode, [bool $useCache = TRUE], [bool $debug = FALSE])

• mixed $aNode: (DMBS_TREE_NODE) a node object or (int) a node id
• bool $useCache
• bool $debug

---

Redefinition of:

DBMS_TREE::getRootPath()

returns an array of pointers to the elements till root with all

setChildNodes (line 417)

sets the child array of $aKey

• access: public

void setChildNodes (string $aKey, array $arr_nodes, boolean $debug)

• string $aKey
• array $arr_nodes
• boolean $debug

setMyProject (line 182)

sets the CMS Project

• access: public

void setMyProject ( &$aProject, CMS_PROJECT $aProject)

• CMS_PROJECT $aProject
• &$aProject

Inherited Methods

Inherited From DBMS_TREE

DBMS_TREE::DBMS_TREE()
DBMS_TREE::addNodeObjectToCache()
DBMS_TREE::filterAdd()
DBMS_TREE::filterClear()
DBMS_TREE::filterRemoveKey()
DBMS_TREE::getChildrenCursor()
DBMS_TREE::getChildrenList()
DBMS_TREE::getFilteredChildrenList()
DBMS_TREE::getGlobalTreeKey()
DBMS_TREE::getIndexedTreeArr()
DBMS_TREE::getKey()
DBMS_TREE::getKeyTree()
DBMS_TREE::getKeyTreeNode()
DBMS_TREE::getNode()
DBMS_TREE::getNodeDBRowFromDB()
DBMS_TREE::getNodeObjectFromCache()
DBMS_TREE::getRootId()
DBMS_TREE::getRootPath()
DBMS_TREE::getTreeArray()
DBMS_TREE::newNodeObject()
DBMS_TREE::populate()
DBMS_TREE::populateNode()
DBMS_TREE::populateTree()
DBMS_TREE::setChildClassVar()
DBMS_TREE::setGlobalTreeKey()
DBMS_TREE::setKey()
DBMS_TREE::setKeyTree()
DBMS_TREE::setRootId()

Inherited From DBMS_TABLEOBJ

DBMS_TABLEOBJ::DBMS_TABLEOBJ()
DBMS_TABLEOBJ::cacheRestore()
DBMS_TABLEOBJ::cacheWriteTo()
DBMS_TABLEOBJ::clearErrors()
DBMS_TABLEOBJ::dbDelete()
DBMS_TABLEOBJ::dbGetDataArray()
DBMS_TABLEOBJ::dbGetForm()
DBMS_TABLEOBJ::dbInsert()
DBMS_TABLEOBJ::dbPopulate()
DBMS_TABLEOBJ::dbReplace()
DBMS_TABLEOBJ::dbSave()
DBMS_TABLEOBJ::db_SetKey()
DBMS_TABLEOBJ::db_SetKeyArray()
DBMS_TABLEOBJ::getClassInclude()
DBMS_TABLEOBJ::getDbDesc()
DBMS_TABLEOBJ::getDBField()
DBMS_TABLEOBJ::getDBRow()
DBMS_TABLEOBJ::getDBVal()
DBMS_TABLEOBJ::getDefaults()
DBMS_TABLEOBJ::getErrorMsg()
DBMS_TABLEOBJ::getFieldDBDefault()
DBMS_TABLEOBJ::getForm()
DBMS_TABLEOBJ::getFormClassName()
DBMS_TABLEOBJ::getFormName()
DBMS_TABLEOBJ::getJSON()
DBMS_TABLEOBJ::getKeyArr()
DBMS_TABLEOBJ::getMyTable()
DBMS_TABLEOBJ::getObjValArray()
DBMS_TABLEOBJ::getObjValValue()
DBMS_TABLEOBJ::getPopulateTs()
DBMS_TABLEOBJ::getWhere()
DBMS_TABLEOBJ::hasChanged()
DBMS_TABLEOBJ::hasColumn()
DBMS_TABLEOBJ::hasErrors()
DBMS_TABLEOBJ::hasObjVals()
DBMS_TABLEOBJ::init()
DBMS_TABLEOBJ::isInit()
DBMS_TABLEOBJ::isPopulated()
DBMS_TABLEOBJ::keysAreSet()
DBMS_TABLEOBJ::populateFromKeys()
DBMS_TABLEOBJ::populateFromValues()
DBMS_TABLEOBJ::populateObjVals()
DBMS_TABLEOBJ::p_cacheIsExpired()
DBMS_TABLEOBJ::saveLinkedRow()
DBMS_TABLEOBJ::saveLinkedTableRows()
DBMS_TABLEOBJ::saveObjVals()
DBMS_TABLEOBJ::setChanged()
DBMS_TABLEOBJ::setDBField()
DBMS_TABLEOBJ::setDBFieldIfDiff()
DBMS_TABLEOBJ::setDBFieldIfEmpty()
DBMS_TABLEOBJ::setDBRow()
DBMS_TABLEOBJ::setDBVal()
DBMS_TABLEOBJ::setDefaults()
DBMS_TABLEOBJ::setError()
DBMS_TABLEOBJ::setLinkedTableRow()
DBMS_TABLEOBJ::setMyTable()
DBMS_TABLEOBJ::setObjValArray()
DBMS_TABLEOBJ::setObjValValue()
DBMS_TABLEOBJ::setObjVarIfEmpty()
DBMS_TABLEOBJ::setUnChanged()
DBMS_TABLEOBJ::userIsAllowed()
DBMS_TABLEOBJ::writeDebugInfo()
DBMS_TABLEOBJ::xmladdDOMElement()
DBMS_TABLEOBJ::xmlExport()
DBMS_TABLEOBJ::_getCacheFileName()
DBMS_TABLEOBJ::_getDBFields()

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_SRC_FILE = __FILE__ (line 52)

• abstract:

Inherited Constants

Inherited from DBMS_TABLEOBJ

DBMS_TABLEOBJ::CLASS_SRC_FILE

Inherited from OCSP_OBJ

OCSP_OBJ::CLASS_SRC_FILE