Implements interfaces:

• INFA_CMS_PAGE_TEMPLATE

handels Page templates

• author: Peter Krebs <pitlinz@users.sourceforge.net>
• version: $Id: CMS_PAGE_TEMPLATE.phpclass,v 1.14 2008/12/16 17:40:40 peterkrebs Exp $
• project: Open CSP-Management
• license: GNU Public License

Located in /cms/template/page/CMS_PAGE_TEMPLATE.phpclass (line 38)

OCSP_OBJ
   |
   --DBMS_TABLEOBJ
      |
      --CMS_TABLEOBJ
         |
         --CMS_PAGE_TEMPLATE

static mixed $loadedTemplates = array() (line 61)

• staticvar: array $loadedTemplates:
• access: protected

string $myClassSrcFile = __FILE__ (line 126)

• var: class source file
• since: pk-05-01-31

mixed $myColPrevix = "PTMP" (line 120)

• staticvar: myColPrevix 0:
• since: pk-05-01-30

mixed $myTable = "T_CMS_TMPL_PAGE" (line 114)

• staticvar: string $myTable: name of the db table

---

Redefinition of:

DBMS_TABLEOBJ::$myTable

NOT FINAL !!!!!

mixed $type = "PAGE" (line 109)

• staticvar: string $type: OBJECT TYPE

---

Redefined in descendants as:

• CMS_FORM_TEMPLATE::$type
• CMS_LIST_TEMPLATE::$type

Inherited Variables

Inherited from CMS_TABLEOBJ

CMS_TABLEOBJ::$cms_conf_data
CMS_TABLEOBJ::$cms_menu_types
CMS_TABLEOBJ::$cms_pageTmpl_types
CMS_TABLEOBJ::$cms_page_types
CMS_TABLEOBJ::$currentMenu
CMS_TABLEOBJ::$currentPage
CMS_TABLEOBJ::$currentProj
CMS_TABLEOBJ::$myCmsCache
CMS_TABLEOBJ::$myMenuIdCol
CMS_TABLEOBJ::$myMenuIdGetName
CMS_TABLEOBJ::$myMenuNode
CMS_TABLEOBJ::$myPageIdCol
CMS_TABLEOBJ::$myPageIdGetName
CMS_TABLEOBJ::$myPageObj
CMS_TABLEOBJ::$myProjIdCol
CMS_TABLEOBJ::$myProjIdGetName
CMS_TABLEOBJ::$myProjObj

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

static CMS_PAGE_TEMPLATE_FROM_ID (line 171)

factory method for a template by PTMP_ID

• since: pk-08-01-15
• access: public

CMS_PAGE_TEMPLATE CMS_PAGE_TEMPLATE_FROM_ID (int $aId, boolean $debug)

• int $aId
• boolean $debug

static factoryFromId (line 183)

factories a page template from an id

• access: public

CMS_PAGE_TEMPLATE factoryFromId (int $aId, [boolean $debug = False])

• int $aId
• boolean $debug

static factoryFromRow (line 266)

factories a page template from an id

• since: pk-08-10-16
• access: public

CMS_PAGE_TEMPLATE factoryFromRow ( $aRow, [boolean $debug = False], int $aId)

• int $aId
• boolean $debug
• $aRow

static getInstance (line 73)

returns an unit of work instance

• access: public

CMS_PAGE_TEMPLATE &getInstance (int $aId, [boolean $debug = False])

• int $aId
• boolean $debug

Constructor CMS_PAGE_TEMPLATE (line 148)

init the object and populates the object if aId

CMS_PAGE_TEMPLATE CMS_PAGE_TEMPLATE ([ $id = 0], [string $name = ""], [int $projId = 0], [bool $debug = FALSE], int $aId, string $gDBIDX)

• int $aId: id of an existing template
• string $name
• int $projId
• string $gDBIDX: GLOBALS database Object index
• bool $debug
• $id

copyChapterFrom (line 626)

copies all chapter templates from $ptmpId

• since: pk-06-01-02

void copyChapterFrom (int $ptmpId, [boolean $debug = FALSE])

• int $ptmpId
• boolean $debug

curUserCanEdit (line 599)

returns if the current user can edit the template

• since: pk-08-12-04
• access: public

boolean curUserCanEdit ([boolean $debug = False])

• boolean $debug

curUserCanShow (line 578)

returns if the current user can open the template

• access: public

boolean curUserCanShow ([boolean $debug = False])

• boolean $debug

dbDelete (line 384)

deletes the template with all chapter templates from the database

NOTE: foreign tables are hardcoded here

• version: pk-06-10-25
• since: pk-04-12-30

boolean dbDelete ([boolean $backupData = FALSE], [boolean $debug = FALSE], string $gDBIDX)

• string $gDBIDX
• boolean $backupData
• boolean $debug

---

Redefinition of:

DBMS_TABLEOBJ::dbDelete()

dbSave (line 348)

saves the template and ensures that there is only one default template per project

• since: pk-05-07-22

mixed dbSave ([boolean $debug = FALSE], string $gDBIDX)

• string $gDBIDX
• boolean $debug

---

Redefinition of:

DBMS_TABLEOBJ::dbSave()

save the Object if $this->autoIncFld is not empty

factoryChapterFromRow (line 688)

• access: public

void factoryChapterFromRow ( $aRow)

• $aRow

getBodyTag (line 807)

• version: pk-05-09-06

string getBodyTag ()

getChapterTemplate (line 653)

returns a chapter template object

TMPL_CHAPTER &getChapterTemplate (int $ctmpId, [boolean $debug = False])

• int $ctmpId
• boolean $debug

getChaTemplateNames (line 669)

returns an array of chapter template names with chapter template ID as index

• access: public

void getChaTemplateNames ([boolean $getAll = False], [boolean $debug = False])

• boolean $getAll
• boolean $debug

getCSSTag (line 722)

returns the style definition for the template

includes the code of the style with id $this->STY_ID and appends the text (as is!!) in $this->getDBField('TMPL_CSSCODE')

the return value is treatend as template and parsed with $this->getDBVal() values

• version: pk-05-09-06
• version: pk-06-07-19

string getCSSTag ([boolean $asTemplate = FALSE], [boolean $debug = FALSE])

• boolean $asTemplate: do not parse the return value
• boolean $debug

getDefaults (line 520)

returns an array of db default values

• since: pk-04-08-12

array getDefaults ([bool $debug = FALSE])

• bool $debug

---

Redefinition of:

DBMS_TABLEOBJ::getDefaults()

returns an array of db default values

getFeeterTag (line 827)

• version: pk-05-09-06

string getFeeterTag ()

getHeadLineTag (line 819)

• version: pk-05-09-06

string getHeadLineTag ()

getId (line 297)

int getId ()

getJavaScriptTag (line 798)

• version: pk-05-09-06

string getJavaScriptTag ()

getMetaTag (line 701)

• version: pk-05-09-06

string getMetaTag ()

getName (line 306)

returns the name of the template

string getName ()

getObjVarDef (line 416)

returns a array of variables used by the page object

array[varName]=array( [TYPE] datatype [FLDCLASS] name of DBMS_FIELD* class [CLASSVALS] array of values of [FLDCLASS]

• since: pk-05-01-30

array getObjVarDef ()

getType (line 290)

returns the object type

int getType ()

---

Redefined in descendants as:

• CMS_FORM_TEMPLATE::getType()

isInUse (line 543)

returns if the template or a chapter template is in use

• since: pk-06-10-25

boolean isInUse ([boolean $onlyOnline = TRUE], [boolean $debug = FALSE])

• boolean $onlyOnline: check only pages and chapters with online states
• boolean $debug

setId (line 325)

set the id

• since: pk-06-01-02

void setId (int $aId)

• int $aId

Inherited Methods

Inherited From CMS_TABLEOBJ

CMS_TABLEOBJ::checkMenuNodeProject()
CMS_TABLEOBJ::cmsCacheIsUsable()
CMS_TABLEOBJ::factoryCurrentElements()
CMS_TABLEOBJ::getCMSConf()
CMS_TABLEOBJ::getCmsConfArr()
CMS_TABLEOBJ::getLangId()
CMS_TABLEOBJ::getMenId()
CMS_TABLEOBJ::getMenLinkUrl()
CMS_TABLEOBJ::getMenuIdColName()
CMS_TABLEOBJ::getMenuIdGetName()
CMS_TABLEOBJ::getMyMenuNode()
CMS_TABLEOBJ::getMyPageObj()
CMS_TABLEOBJ::getMyProject()
CMS_TABLEOBJ::getNextMenuId()
CMS_TABLEOBJ::getPageId()
CMS_TABLEOBJ::getPageIdColName()
CMS_TABLEOBJ::getPageIdGetName()
CMS_TABLEOBJ::getPageSortColName()
CMS_TABLEOBJ::getPageTable()
CMS_TABLEOBJ::getPrevMenuId()
CMS_TABLEOBJ::getProjId()
CMS_TABLEOBJ::getProjIdColName()
CMS_TABLEOBJ::getProjIdGetName()
CMS_TABLEOBJ::get_currentMenu()
CMS_TABLEOBJ::get_currentPage()
CMS_TABLEOBJ::get_currentProj()
CMS_TABLEOBJ::menuType_clearCache()
CMS_TABLEOBJ::menuType_getClassSrc()
CMS_TABLEOBJ::menuType_populate()
CMS_TABLEOBJ::menuType_requireClass()
CMS_TABLEOBJ::pageTmplType_getClassSrc()
CMS_TABLEOBJ::pageTmplType_populate()
CMS_TABLEOBJ::pageTmplType_requireClass()
CMS_TABLEOBJ::pageType_getClassSrc()
CMS_TABLEOBJ::pageType_getList()
CMS_TABLEOBJ::pageType_getTmplClassName()
CMS_TABLEOBJ::pageType_populate()
CMS_TABLEOBJ::pageType_requireClass()
CMS_TABLEOBJ::setCmsCacheArr()
CMS_TABLEOBJ::setDBVal()
CMS_TABLEOBJ::setLangId()
CMS_TABLEOBJ::setMenId()
CMS_TABLEOBJ::setMyMenuNode()
CMS_TABLEOBJ::setMyPageObj()
CMS_TABLEOBJ::setMyProject()
CMS_TABLEOBJ::setPageId()
CMS_TABLEOBJ::setProjId()
CMS_TABLEOBJ::set_currentMenu()
CMS_TABLEOBJ::set_currentPage()
CMS_TABLEOBJ::set_currentProj()

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

• abstract:

Inherited Constants

Inherited from DBMS_TABLEOBJ

DBMS_TABLEOBJ::CLASS_SRC_FILE

Inherited from OCSP_OBJ

OCSP_OBJ::CLASS_SRC_FILE