openCSP class DBMS_SIMPLETREE

handles a simple tree

a single table with an integer parent field the root index is 0

• author: Peter Krebs <pitlinz@users.sourceforge.net>
• version: $Id: DBMS_SIMPLETREE.phpclass,v 1.1 2008/12/04 16:45:40 peterkrebs Exp $
• abstract:
• project: Open CSP-Management
• since: pk-22.11.2008
• license: GNU Public License

Located in /db/DBMS_SIMPLETREE.phpclass (line 38)

OCSP_OBJ
   |
   --DBMS_TABLEOBJ
      |
      --DBMS_SIMPLETREE

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

• access: protected

static mixed $myTreeClass = "" (line 55)

* class vars ------------------------------------------------------

• access: protected

static mixed $myTreeIndexCol = "" (line 57)

• access: protected

---

Redefined in descendants as:

• INTEREST::$myTreeIndexCol

static mixed $myTreeParentCol = "" (line 58)

• access: protected

---

Redefined in descendants as:

• INTEREST::$myTreeParentCol

static mixed $myTreePopulateTS = array() (line 64)

• access: protected

static mixed $myTreeRootId = 0 (line 61)

• access: protected

static mixed $myTreeSort = "" (line 59)

• access: protected

---

Redefined in descendants as:

• INTEREST::$myTreeSort

static mixed $myTreeTable = "" (line 56)

• access: protected

---

Redefined in descendants as:

• INTEREST::$myTreeTable : * class vars ------------------------------------------------------

Inherited Variables

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 factoryFromDBRow (line 193)

factories a node

• abstract:
• access: public

DBMS_SIMPLETREE &factoryFromDBRow ( $aRow, int $aId)

• int $aId
• $aRow

---

Redefined in descendants as:

• INTEREST::factoryFromDBRow() : factories a node

static factoryFromId (line 184)

factories a node

• abstract:
• access: public

DBMS_SIMPLETREE &factoryFromId (int $aId)

• int $aId

---

Redefined in descendants as:

• INTEREST::factoryFromId() : factories a node

static getAllInstances (line 151)

returns an array with all populated instances

• access: public

array; getAllInstances ()

static getInstance (line 120)

returns the instance with id $aId

if the instance has not been loaded factoryFromId is called

• access: public

DBMS_SIMPLETREE getInstance (int $aId)

• int $aId

static getRootNode (line 141)

returns the root node

• access: public

DMBS_SIMPLETREE getRootNode ()

static populateTree (line 88)

popluates the tree

• return: (number of loaded nodes)
• access: public

int populateTree ([ $filter = Null], [boolean $debug = False], array $arr_filter)

• array $arr_filter: ('KEY' => value pairs)
• boolean $debug
• $filter

static treeIsPopulated (line 74)

returns if the tree is already populated

• access: public

boolean treeIsPopulated ()

getId (line 218)

returns the id

• access: public

int getId ()

getParentId (line 228)

returns the parent id

• access: public

int getParentId ()

init (line 202)

sets the table name for DBMS_TABLEOBJ

void init ([boolean $debug = False], [boolean $noCache = False])

• boolean $debug
• boolean $noCache

---

Redefinition of:

DBMS_TABLEOBJ::init()

initalize the object

isRoot (line 238)

returns if the node is the root node

• access: public

boolean isRoot ()

Inherited Methods

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

Inherited Constants

Inherited from DBMS_TABLEOBJ

DBMS_TABLEOBJ::CLASS_SRC_FILE

Inherited from OCSP_OBJ

OCSP_OBJ::CLASS_SRC_FILE