Class CMS_SUMMARYPAGE

Description

Class CMS_SUMMARYPAGE

shows the chapters of all pages in CMS_SUMMARYPAGE::pages where $GLOBALS['CMS']['CHAPTER_PAGEMODE'][$this->CHA_SHOWMODE]['SUMMARY] == TRUE

  • author: Peter Krebs <p.krebs@lvus.at>
  • version: pk-03-10-24 parent changed DBMS_TBLOBJ -> CMS_TBLOBJ
  • copyright: (c) 2002-2003 by Peter Krebs and Landesverlag Unternehmensservice
  • project: Open CSP-Management
  • license: GNU Public License

Located in /cms/page/CMS_SUMMARYPAGE.phpclass (line 32)

OCSP_OBJ
   |
   --DBMS_TABLEOBJ
      |
      --CMS_TABLEOBJ
         |
         --CMS_PAGE
            |
            --CMS_PAGE_V2
               |
               --CMS_SUMMARYPAGE
Variable Summary
 mixed $myClassName
 array $pages
Method Summary
 CMS_SUMMARYPAGE CMS_SUMMARYPAGE ([int $projId = 0], [int $menId = 0], [int $aId = 0], [int $langId = 0], [bool $debug = FALSE])
 DBMS_FORM &dbGetForm (int $mode, [string $frmName = ""], [ $debug = FALSE])
 bool dbPopulateDB ([string $gDBIDX = "USRDB"], [bool $debug = FALSE])
 void dbSave ([ $gDBIDX = "USRDB"],  $debug)
 string getChapQuery ([ $showAllStates = FALSE], [bool $showTimedOut = FALSE], [ $showFuter = FALSE], [ $showGroup = 0], [string $addWhere = ""], [ $debug = FALSE], bool $showAll, bool $showFuture)
 array getChaTemplates ([bool $debug = FALSE])
Variables
mixed $myClassName = "CMS_SUMMARYPAGE" (line 36)

Redefinition of:
CMS_PAGE_V2::$myClassName
array $pages = array() (line 41)
  • var: list of pages to check
int $pagesmenId = -1 (line 46)
  • var: if > 0 use all pages in this menu

Inherited Variables

Inherited from CMS_PAGE_V2

CMS_PAGE_V2::$chapPrevix
CMS_PAGE_V2::$chaTmpl
CMS_PAGE_V2::$chaTmplArr
CMS_PAGE_V2::$cmsPageList
CMS_PAGE_V2::$colPrevix
CMS_PAGE_V2::$cTable
CMS_PAGE_V2::$ctmplClass
CMS_PAGE_V2::$ctmplFldPrevix
CMS_PAGE_V2::$ctmplTable
CMS_PAGE_V2::$moduleKey
CMS_PAGE_V2::$myChapterClass
CMS_PAGE_V2::$myTmpl
CMS_PAGE_V2::$nextId
CMS_PAGE_V2::$prevId

Inherited from CMS_PAGE

CMS_PAGE::$dbRow
CMS_PAGE::$formObj
CMS_PAGE::$langId
CMS_PAGE::$myDB
CMS_PAGE::$myForm
CMS_PAGE::$myTable
CMS_PAGE::$pageId
CMS_PAGE::$projId

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
Methods
Constructor CMS_SUMMARYPAGE (line 59)

init the object and populates it if (intval($aId))

CMS_SUMMARYPAGE CMS_SUMMARYPAGE ([int $projId = 0], [int $menId = 0], [int $aId = 0], [int $langId = 0], [bool $debug = FALSE])
  • int $projId: the project ID
  • int $menId: the menu ID
  • int $aId: the page ID
  • int $langId: the language ID
  • bool $debug
dbGetForm (line 131)

returns a database form

  • todo: input field PAGES is allways enabled
DBMS_FORM &dbGetForm (int $mode, [string $frmName = ""], [ $debug = FALSE])
  • int $mode: dbms form show mode
  • string $frmName: dbms form name
  • $debug

Redefinition of:
DBMS_TABLEOBJ::dbGetForm()
returns a database form
dbPopulateDB (line 82)

unserialze the object field after populate with parent::dbPopulateDB

  • return: found row ?
  • version: pk-03-12-14 fixed bug no return value
bool dbPopulateDB ([string $gDBIDX = "USRDB"], [bool $debug = FALSE])
  • string $gDBIDX: GLOBAL ARRAY INDEX OF DB OBJECT
  • bool $debug: SHOW DEBUG INFO
dbSave (line 101)

saves the object to the database

if the object is populated dbReplace is called otherwise dbInsert is called

Allways use dbSave to be sure object elements are serialized

void dbSave ([ $gDBIDX = "USRDB"],  $debug)
  • $gDBIDX
  • $debug

Redefinition of:
DBMS_TABLEOBJ::dbSave()
save the Object if $this->autoIncFld is not empty
getChapQuery (line 178)

returns the query string to select the chapters

adds $addWhere between WHERE and ORDER BY

  1.  $query.=" AND LANG_ID=".$this->getLangId();
  2.  $query.=$addWhere;
  3.  $query.=" ORDER BY ".$this->."_SORTORDER";

  • since: pk-03-12-14
string getChapQuery ([ $showAllStates = FALSE], [bool $showTimedOut = FALSE], [ $showFuter = FALSE], [ $showGroup = 0], [string $addWhere = ""], [ $debug = FALSE], bool $showAll, bool $showFuture)
  • bool $showAll: don't care about chapter state
  • bool $showTimedOut: show chapters with SHOWTILL date in past
  • bool $showFuture: show chapters with SHOWFROM date in futur
  • string $addWhere
  • $showAllStates
  • $showFuter
  • $showGroup
  • $debug

Redefinition of:
CMS_PAGE_V2::getChapQuery()
getChaTemplates (line 115)

returns an array of chapter template names with chapter template ID as index returns false if the page does not support chapter input

array getChaTemplates ([bool $debug = FALSE])
  • bool $debug

Redefinition of:
CMS_PAGE::getChaTemplates()
getPageOnlineStates (line 150)

returns a comma seperated list of page states to show

  • since: pk-03-12-18
array getPageOnlineStates ()

Inherited Methods

Inherited From CMS_PAGE_V2

 CMS_PAGE_V2::CMS_PAGE_V2()
 CMS_PAGE_V2::CMS_PAGE_FROM_DBROW()
 CMS_PAGE_V2::CMS_PAGE_FROM_GET()
 CMS_PAGE_V2::CMS_PAGE_SUBCLASS_NAME()
 CMS_PAGE_V2::dbDelete()
 CMS_PAGE_V2::dbInsert()
 CMS_PAGE_V2::getBodyInclude()
 CMS_PAGE_V2::getChapQuery()
 CMS_PAGE_V2::getChaTemplateObj()
 CMS_PAGE_V2::getFeedbackForm()
 CMS_PAGE_V2::getId()
 CMS_PAGE_V2::getObjClass()
 CMS_PAGE_V2::getObjVarDef()
 CMS_PAGE_V2::getOrderNr()
 CMS_PAGE_V2::loadChaTemplate()
 CMS_PAGE_V2::loadTemplate()
 CMS_PAGE_V2::moveSortDown()
 CMS_PAGE_V2::moveSortFirst()
 CMS_PAGE_V2::moveSortLast()
 CMS_PAGE_V2::moveSortUp()
 CMS_PAGE_V2::populateValidated()
 CMS_PAGE_V2::saveFeedBackForm()
 CMS_PAGE_V2::setAsCurrent()
 CMS_PAGE_V2::setDefaults()
 CMS_PAGE_V2::setId()
 CMS_PAGE_V2::setTemplateId()

Inherited From CMS_PAGE

 CMS_PAGE::CMS_PAGE()
 CMS_PAGE::checkDb()
 CMS_PAGE::getChapter()
 CMS_PAGE::getChaTemplates()
 CMS_PAGE::getClassName()
 CMS_PAGE::getCSSHeaderTag()
 CMS_PAGE::getDBField()
 CMS_PAGE::getDBRow()
 CMS_PAGE::getFeeter()
 CMS_PAGE::getFeeterTag()
 CMS_PAGE::getForm()
 CMS_PAGE::getFormDateFromPost()
 CMS_PAGE::getHead()
 CMS_PAGE::getHeadlineTag()
 CMS_PAGE::getId()
 CMS_PAGE::getJavaHeaderTag()
 CMS_PAGE::getMenuId()
 CMS_PAGE::getNextPage()
 CMS_PAGE::getObjVars()
 CMS_PAGE::getPreviousPage()
 CMS_PAGE::getStylesLink()
 CMS_PAGE::loadFromDB()
 CMS_PAGE::loadTemplate()
 CMS_PAGE::preview()
 CMS_PAGE::setArray()
 CMS_PAGE::setDB()
 CMS_PAGE::setDBField()
 CMS_PAGE::updateToDB()
 CMS_PAGE::view()
 CMS_PAGE::writeADMForm()

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 Constants

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