Abstract Class CMS_TABLEOBJ

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

Abstract Class CMS_TABLEOBJ

Extends DBMS_TABLEOBJ with some common cms aspects

Located in /cms/CMS_TABLEOBJ.phpclass (line 36) 

OCSP_OBJ
   |
   --DBMS_TABLEOBJ
      |
      --CMS_TABLEOBJ
Direct descendents
Description | Descendents | Vars (details) | Methods (details) Constants
Class Description
class CLI_PROFILE class to handel CLI_PROFILES
class CMS_CHAPTER openCSP class CMS_CHAPTER
class CMS_PROJECT Class file CMS_PROJECT.phpclass
class CMS_CSSCLASS handels CSS Class Files
class CMS_CSSSTYLE handels CSS Style Files
class openCSP class file
class TMPL_CHAPTER Handels chapter templates
class CMS_PAGE_TEMPLATE handels Page templates
Variable Summary
Description | Descendants | Vars (details) | Methods (details) Constants
static mixed $cms_conf_data
static mixed $cms_menu_types
static mixed $cms_pageTmpl_types
static mixed $cms_page_types
static mixed $currentMenu
static mixed $currentPage
static mixed $currentProj
OCSP_CMS_PEARCACHE $myCmsCache
mixed $myMenuIdCol
string $myMenuIdGetName
CMS_MENU_NODE $myMenuNode
mixed $myPageIdCol
string $myPageIdGetName
CMS_PAGE $myPageObj
string $myProjIdCol
string $myProjIdGetName
CMS_PROJECT $myProjObj
Method Summary
Description | Descendants | Constants Vars (details) | Methods (details)
static boolean factoryCurrentElements ([boolean $debug = False])
static mixed getCMSConf (string $name)
static mixed getCmsConfArr ([unknown_type $subElem = ""])
static string getMenuIdColName ()
static string getMenuIdGetName ()
static string getPageIdColName ()
static string getPageIdGetName ()
static string getPageSortColName ()
static string getPageTable ()
static string getProjIdColName ()
static string getProjIdGetName ()
static CMS_MENU_NODE &get_currentMenu ()
static CMS_PAGE &get_currentPage ()
static CMS_PROJECT &get_currentProj ()
static void menuType_clearCache ([boolean $debug = False])
static string menuType_getClassSrc (string $aClassName, [boolean $canPopulate = True], [boolean $debug = False])
static void menuType_populate ([boolean $debug = False])
static void menuType_requireClass ( $aClassName, [ $debug = False], string $class)
static string pageTmplType_getClassSrc (string $aClassName, [boolean $canPopulate = True], [boolean $debug = False])
static void pageTmplType_populate ([boolean $debug = False])
static boolean pageTmplType_requireClass ( $aClassName, [ $debug = False], string $class)
static string pageType_getClassSrc (string $aClassName, [boolean $canPopulate = True], [boolean $debug = False])
static void pageType_getList ([boolean $debug = False])
static string pageType_getTmplClassName (string $aClassName, [boolean $debug = False])
static void pageType_populate ([boolean $debug = False], [ $useCache = True])
static void pageType_requireClass ( $aClassName, [ $debug = False], string $class)
static void set_currentMenu ( &$menNode, [ $debug = False], CMS_MENU $menNode)
static void set_currentPage ( &$page, [boolean $debug = False], CMS_PAGE $page)
static void set_currentProj ( &$project, [ $debug = False], CMS_PROJECT $project)
CMS_MENU_NODE &checkMenuNodeProject ([boolean $debug = FALSE])
boolean cmsCacheIsUsable ()
int getLangId ()
int getMenId ()
string getMenLinkUrl ([boolean $debug = FALSE])
CMS_MENU_NODE &getMyMenuNode ([boolean $debug = False])
CMS_PAGE &getMyPageObj ([boolean $debug = False])
CMS_PROJECT &getMyProject ([boolean $setAsCurrent = False], [boolean $debug = False], [boolean $forceObj = True])
int getNextMenuId ([boolean $onlineOnly = TRUE], [boolean $debug = FALSE])
int getPageId ()
int getPrevMenuId ([boolean $onlineOnly = TRUE], [boolean $debug = FALSE])
int getProjId ([boolean $debug = False])
boolean setCmsCacheArr (array $cacheArr, boolean $debug)
void setDBVal (array $valArr, [boolean $debug = FALSE])
void setLangId (int $aId)
void setMenId (int $aId)
void setMyMenuNode ( &$aNode, [boolean $debug = False], CMS_MENU_NODE $aNode)
void setMyPageObj ( &$aPageObj, [boolean $debug = FALSE], CMS_PAGE $aPageObj)
void setMyProject (CMS_PROJECT &$aProjObj, [boolean $debug = False])
void setPageId (int $pagId)
void setProjId ($aId $aId)
Variables
Description | Descendents | Vars (details) Constants | Methods (details)
static mixed $cms_conf_data = array() (line 51)
static mixed $cms_menu_types = array() (line 120)

---------------------------------------------------------------

static mixed $cms_pageTmpl_types = array() (line 320)
  • staticvar: array $cms_pageTmpl_types:
  • since: pk-08-06-16
static mixed $cms_page_types = array() (line 492)

---------------------------------------------------------------

static mixed $currentMenu = Null (line 733)
static mixed $currentPage = Null (line 739)
  • staticvar: CMS_PAGE $currentPage:
  • access: protected
static mixed $currentProj = Null (line 728)
  • staticvar: CMS_PROJECT $currentProject:
  • access: protected
OCSP_CMS_PEARCACHE $myCmsCache = NULL (line 1048)
  • access: protected
mixed $myMenuIdCol = "MEN_ID" (line 1086)
  • staticvar: string $myMenuIdCol:
  • since: pk-05-07-21
  • access: protected
string $myMenuIdGetName = "ocspM" (line 1091)
  • access: protected
CMS_MENU_NODE $myMenuNode = Null (line 1059)
  • access: protected
mixed $myPageIdCol = "PAG_ID" (line 1098)
  • staticvar: string $myPageIdCol:
  • since: pk-05-07-28
  • access: protected
string $myPageIdGetName = "ocspS" (line 1105)
CMS_PAGE $myPageObj = Null (line 1064)
  • access: protected
string $myProjIdCol = "PROJ_ID" (line 1074)
  • since: pk-05-07-21
  • access: protected
string $myProjIdGetName = "ocspP" (line 1080)
  • since: pk-07-06-07
  • access: protected
CMS_PROJECT $myProjObj = Null (line 1054)
  • since: pk-05-09-01
  • access: protected

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
Methods
Description | Descendents | Vars (details) Methods (details)
static factoryCurrentElements (line 858)

facotries the current elements from the environment

  • access: public
boolean factoryCurrentElements ([boolean $debug = False])
  • boolean $debug
static getCMSConf (line 63)

returns a cms configuration

  • deprecated: since pk-08-07-15
  • access: public
mixed getCMSConf (string $name)
  • string $name
static getCmsConfArr (line 97)

returns the CMS configuration array or

  • deprecated: since pk-08-07-15
  • access: public
mixed getCmsConfArr ([unknown_type $subElem = ""])
  • unknown_type $subElem
static getMenuIdColName (line 815)
  • since: pk-07-08-14
  • access: public
string getMenuIdColName ()
static getMenuIdGetName (line 802)
  • since: pk-07-08-14
  • access: public
string getMenuIdGetName ()
static getPageIdColName (line 759)
  • since: pk-07-08-14
  • access: public
string getPageIdColName ()
static getPageIdGetName (line 746)
  • since: pk-07-08-14
  • access: public
string getPageIdGetName ()
static getPageSortColName (line 772)

returns the page sort column

  • access: public
string getPageSortColName ()
static getPageTable (line 787)

returns the page table name

  • access: public
string getPageTable ()
static getProjIdColName (line 841)
  • since: pk-07-08-14
  • access: public
string getProjIdColName ()
static getProjIdGetName (line 828)
  • since: pk-07-08-14
  • access: public
string getProjIdGetName ()
static get_currentMenu (line 956)

returns the current menu node

  • version: pk-08-10-05 (compate with old global $OCSP_OBJ)
  • access: public
CMS_MENU_NODE &get_currentMenu ()
static get_currentPage (line 979)
  • access: public
CMS_PAGE &get_currentPage ()
static get_currentProj (line 936)

returns the current project

if !isset self::$currentProj and $OCSP_OBJ['CUR_CMSPROJ'] is set $OCSP_OBJ['CUR_CMSPROJ'] is set as current project

  • access: public
CMS_PROJECT &get_currentProj ()
static menuType_clearCache (line 294)

clears the menuType cache

  • since: pk-08-06-14
  • access: public
void menuType_clearCache ([boolean $debug = False])
  • boolean $debug
static menuType_getClassSrc (line 206)

returns the source file (absolute path) of a menutype

  • since: pk-08-06-13
  • access: public
string menuType_getClassSrc (string $aClassName, [boolean $canPopulate = True], [boolean $debug = False])
  • string $aClassName
  • boolean $canPopulate: (to avoid endless loops)
  • boolean $debug
static menuType_populate (line 129)

loads the cms menu types

  • since: pk-08-06-10
  • access: public
void menuType_populate ([boolean $debug = False])
  • boolean $debug
static menuType_requireClass (line 271)

require menu object class

  • access: public
void menuType_requireClass ( $aClassName, [ $debug = False], string $class)
  • string $class
  • $aClassName
  • $debug
static pageTmplType_getClassSrc (line 399)

returns the source file (absolute path) of a pagetype

  • since: pk-08-06-16
  • access: public
string pageTmplType_getClassSrc (string $aClassName, [boolean $canPopulate = True], [boolean $debug = False])
  • string $aClassName
  • boolean $canPopulate: (to avoid endless loops)
  • boolean $debug
static pageTmplType_populate (line 329)

loads the cms page types

  • since: pk-08-06-16
  • access: public
void pageTmplType_populate ([boolean $debug = False])
  • boolean $debug
static pageTmplType_requireClass (line 468)

require page object class

  • since: pk-08-06-16
  • access: public
boolean pageTmplType_requireClass ( $aClassName, [ $debug = False], string $class)
  • string $class
  • $aClassName
  • $debug
static pageType_getClassSrc (line 589)

returns the source file (absolute path) of a pagetype

  • since: pk-08-06-16
  • access: public
string pageType_getClassSrc (string $aClassName, [boolean $canPopulate = True], [boolean $debug = False])
  • string $aClassName
  • boolean $canPopulate
  • boolean $debug
static pageType_getList (line 712)

returns an array with all page types

  • since: pk-08-08-11
  • access: public
void pageType_getList ([boolean $debug = False])
  • boolean $debug
static pageType_getTmplClassName (line 685)

returns the default template class name of a page type

  • since: pk-08-06-16
  • access: public
string pageType_getTmplClassName (string $aClassName, [boolean $debug = False])
  • string $aClassName
  • boolean $debug
static pageType_populate (line 501)

loads the cms page types

  • since: pk-08-06-10
  • access: public
void pageType_populate ([boolean $debug = False], [ $useCache = True])
  • boolean $debug
  • $useCache
static pageType_requireClass (line 658)

require page object class

  • access: public
void pageType_requireClass ( $aClassName, [ $debug = False], string $class)
  • string $class
  • $aClassName
  • $debug
static set_currentMenu (line 1009)
  • access: public
void set_currentMenu ( &$menNode, [ $debug = False], CMS_MENU $menNode)
static set_currentPage (line 1027)
  • access: public
void set_currentPage ( &$page, [boolean $debug = False], CMS_PAGE $page)
static set_currentProj (line 994)
  • access: public
void set_currentProj ( &$project, [ $debug = False], CMS_PROJECT $project)
checkMenuNodeProject (line 1451)

checks if $this->myMenuNode has a project object if not $this->getMyProject is set to the menu

  • since: pk-07-08-23
  • access: protected
CMS_MENU_NODE &checkMenuNodeProject ([boolean $debug = FALSE])
  • boolean $debug
cmsCacheIsUsable (line 1618)

returns if the cms cache is usable

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

boolean cmsCacheIsUsable ()
getLangId (line 1304)

returns the cms language id

int getLangId ()
getMenId (line 1331)

returns the cms menu id

  • version: pk-08-06-17
int getMenId ()
getMenLinkUrl (line 1478)

retuns the link url of the menu (without page)

  • since: pk-07-01-10
string getMenLinkUrl ([boolean $debug = FALSE])
  • boolean $debug
getMyMenuNode (line 1367)

returns the menu node of the object if $this->myMenuNode is not set or NULL a new object is generated if $this->myMenuNode->getId() != $this->getMenId() a new objec is generated

  • version: pk-07-08-14 memory and pear cache usage
  • since: pk-06-11-12
CMS_MENU_NODE &getMyMenuNode ([boolean $debug = False])
  • boolean $debug
getMyPageObj (line 1581)
  • version: pk-08-05-09 bugfix
CMS_PAGE &getMyPageObj ([boolean $debug = False])
  • boolean $debug
getMyProject (line 1225)

returns the Project Object

  • version: pk-05-09-06
  • version: pk-07-06-07
  • version: pk-07-08-13
  • version: pk-08-11-22
  • requires: CMS_PROJECT.phpclass
  • access: public
CMS_PROJECT &getMyProject ([boolean $setAsCurrent = False], [boolean $debug = False], [boolean $forceObj = True])
  • boolean $setAsCurrent: if true and method $this->setAsCurrent() exists it will be called
  • boolean $debug
  • boolean $forceObj: (if true a new object will be instanciated if none is set)
getNextMenuId (line 1524)

returns the previous menü id goes up in the tree if no suitable sibling is found

  • since: pk-07-01-10
int getNextMenuId ([boolean $onlineOnly = TRUE], [boolean $debug = FALSE])
  • boolean $onlineOnly: only check menus which are currently online
  • boolean $debug
getPageId (line 1546)

returns the cms page id

int getPageId ()
getPrevMenuId (line 1500)

returns the previous menü id goes up in the tree if no suitable sibling is found

  • since: pk-07-01-10
int getPrevMenuId ([boolean $onlineOnly = TRUE], [boolean $debug = FALSE])
  • boolean $onlineOnly: only check menus which are currently online
  • boolean $debug
getProjId (line 1158)

returns the cms project id

int getProjId ([boolean $debug = False])
  • boolean $debug
setCmsCacheArr (line 1647)

sets the values from a cache array if the object is not populated or have an older populateTS

boolean setCmsCacheArr (array $cacheArr, boolean $debug)
  • array $cacheArr
  • boolean $debug
setDBVal (line 1129)

sets all fields of an array to the objcet if $valArr['PEARCACHE_TS'] isset this will become the populateTS

  • version: pk-07-06-16
  • since: pk-05-08-30
void setDBVal (array $valArr, [boolean $debug = FALSE])
  • array $valArr
  • boolean $debug
Redefinition of:
DBMS_TABLEOBJ::setDBVal()
sets all fields of an array to the objcet
Redefined in descendants as:
  • : sets all fields of an array to the objcet
setLangId (line 1316)

sets the cms language id

void setLangId (int $aId)
  • int $aId: since pk-04-07-30
setMenId (line 1348)

sets the menu id

  • since: pk-05-07-21
void setMenId (int $aId)
  • int $aId
setMyMenuNode (line 1431)

sets the menu node object

  • version: pk-07-10-01
  • since: pk-06-11-12
void setMyMenuNode ( &$aNode, [boolean $debug = False], CMS_MENU_NODE $aNode)
setMyPageObj (line 1564)
void setMyPageObj ( &$aPageObj, [boolean $debug = FALSE], CMS_PAGE $aPageObj)
  • CMS_PAGE $aPageObj
  • boolean $debug
  • &$aPageObj
setMyProject (line 1196)

sets the project object of the page

  • version: pk-06-07-26 setting project ID too
  • version: pk-07-08-13 setting memory cache
  • since: pk-05-07-11
void setMyProject (CMS_PROJECT &$aProjObj, [boolean $debug = False])
setPageId (line 1556)
  • since: pk-05-07-28
void setPageId (int $pagId)
  • int $pagId
setProjId (line 1179)

sets the cms project id

  • version: pk-03-12-12
  • version: pk-05-09-05 bugfix
void setProjId ($aId $aId)
  • $aId $aId: int Project ID

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 Constants
Description | Descendants | Constants (details) Vars (details) | Methods (details)

Inherited Constants

Inherited from DBMS_TABLEOBJ

DBMS_TABLEOBJ::CLASS_SRC_FILE

Inherited from OCSP_OBJ

OCSP_OBJ::CLASS_SRC_FILE

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