Class CMS_MENU_V2

• author: Peter Krebs <pitlinz@users.sourceforge.net>
• version: $Id: CMS_MENU_V2.phpclass,v 1.8 2008/06/16 07:07:03 pitlinz Exp $
• project: Open CSP-Management
• license: GNU Public License

Located in /cms/menu/CMS_MENU_V2.phpclass (line 35)

OCSP_OBJ
   |
   --DBMS_TABLEOBJ
      |
      --DBMS_TREE
         |
         --CMS_MENU_V2

string $myChildClass = "CMS_MENU_NODE" (line 91)

• access: protected

---

Redefinition of:

DBMS_TREE::$myChildClass

string $myChildKeys = "PROJ_ID" (line 97)

• var: NOT FINAL comma sperated list of keys the children have to fit to
• access: protected

---

Redefinition of:

DBMS_TREE::$myChildKeys

mixed $myColPrevix = "MEN_" (line 85)

• staticvar: string $myColPrevix:
• since: pk-07-06-17
• access: protected

mixed $myIdFld = "MEN_ID" (line 66)

• staticvar: string $myIdFld: id column = root
• access: protected

---

Redefinition of:

DBMS_TREE::$myIdFld

mixed $myParentFld = "MEN_PARENT" (line 72)

• staticvar: string $myParentFld: name of the parent column
• access: protected

---

Redefinition of:

DBMS_TREE::$myParentFld

CMS_PROJECT $myProjObj = NULL (line 50)

• since: pk-07-08-15
• access: protected

mixed $mySortFld = "MEN_SORTORDER" (line 78)

• staticvar: string $mySortFld: name of the sort field
• access: protected

---

Redefinition of:

DBMS_TREE::$mySortFld

mixed $myTable = "T_CMS_MENU" (line 60)

• staticvar: string $myTable:
• access: protected

---

Redefinition of:

DBMS_TABLEOBJ::$myTable

NOT FINAL !!!!!

string $pageUrl = "/cms/index.php" (line 104)

url to open for pages

• access: protected

Inherited Variables

Inherited from DBMS_TREE

DBMS_TREE::$childClassColumn
DBMS_TREE::$myChildren
DBMS_TREE::$myChildrenPopulateTS
DBMS_TREE::$myFilterArr
DBMS_TREE::$myGlobalTreeKey
DBMS_TREE::$myLink
DBMS_TREE::$myRootId

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::$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

Constructor CMS_MENU_V2 (line 120)

constructor

• version: pk-04-08-23
• version: pk-07-06-15

CMS_MENU_V2 CMS_MENU_V2 ( &$aProject, [boolean $autoPopulate = True], [boolean $debug = False], mixed $aProject)

• mixed $aProject: (CMS_PROJECT) a project object or (int) a project ID
• boolean $autoPopulate
• boolean $debug
• &$aProject

cmsCacheGetNodeValArr (line 498)

returns the cache array for a node

• since: pk-07-06-18
• access: public

array cmsCacheGetNodeValArr (int $aId, [boolean $debug = False])

• int $aId
• boolean $debug

cmsCacheGetObj (line 514)

• access: public

OCSP_CMS_PEARCACHE &cmsCacheGetObj (boolean $debug)

• boolean $debug

cmsCacheIsUsable (line 468)

returns if the cms cache is usable

if (_OCSP_USEPEARCACHE_) it's ensured that $GLOBALS['OCSP_OBJ']['CMS_PEARCHACHE'] is an object

boolean cmsCacheIsUsable ([boolean $debug = False])

• boolean $debug

getChildrenList (line 202)

returns a array of pointers to the child objects

• version: pk-05-01-06
• version: pk-06-07-27
• version: pk-07-08-09
• since: pk-04-07-23

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

getKeyTreeNode (line 153)

returns a node in the key tree

• since: pk-07-06-16
• requires: common/OCSP_DATE.phpclass
• access: protected

array getKeyTreeNode (array $dbRow, [boolean $debug = False])

• array $dbRow
• boolean $debug

---

Redefinition of:

DBMS_TREE::getKeyTreeNode()

returns a node in the key tree to store more information to the keytree overwrite this in

getProjId (line 402)

• version: pk-07-08-15
• since: pk-05-07-26

int getProjId ()

newNodeObject (line 298)

generates a new child object and add it to the cache

• since: pk-07-10-08

CMS_MENU_NODE &newNodeObject (int $aId, [ $dataArr = NULL], [boolean $debug = False], string $aClassName)

• int $aId: the (cache) id of the object
• string $aClassName: if !empty $this-myChildClass is overwriten if class exists
• boolean $debug
• $dataArr

---

Redefinition of:

DBMS_TREE::newNodeObject()

generates a new child object and add it to the cache

populateNode (line 347)

populates a child

• version: pk-06-07-17
• since: pk-05-11-22

void &populateNode (int $aId, [bool $useCache = True], [bool $debug = False])

• int $aId
• bool $useCache: (ignored here always True)
• bool $debug: return mixed DBMS_TREE_NODE if its a child

---

Redefinition of:

DBMS_TREE::populateNode()

populates a child node if $useCache the cache is checked if the node already exists if !$useCache the node is laoded from the db and the cache object is replaced

populateTree (line 243)

populates the tree

boolean populateTree ([boolean $useCache = True], [boolean $keysOnly = True], [string $where = ""], [boolean $debug = False])

• boolean $useCache: (is ignored here)
• boolean $keysOnly
• string $where
• boolean $debug

---

Redefinition of:

DBMS_TREE::populateTree()

setMyProject (line 444)

void setMyProject ( &$aProject, CMS_PROJECT $aProject)

• CMS_PROJECT $aProject
• &$aProject

setProjId (line 423)

sets the project id if $projId != $this->PROJ_ID and the tree has children (sizeof($this->myChildren)) the childrens are reloaded

• since: pk-05-07-26

void setProjId (int $projId, [ $debug = False])

• int $projId
• $debug

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

Inherited Constants

Inherited from DBMS_TABLEOBJ

DBMS_TABLEOBJ::CLASS_SRC_FILE

Inherited from OCSP_OBJ

OCSP_OBJ::CLASS_SRC_FILE