Class OCSP_CMS_CACHE

Description

Implements interfaces:

openCSP class file

Located in /cms/OCSP_CMS_CACHE.phpclass (line 34)

OCSP_CACHE
   |
   --OCSP_CACHE_FILE
      |
      --OCSP_CMS_CACHE
Class Constant Summary
 CLASS_SRC_FILE = __FILE__
Variable Summary
 static string $cacheSubDirName
Method Summary
 static OCSP_CMS_CACHE getInstance ([string $group = '_NOT_USED_HERE_'])
 void clearPageCache ( $pageObj, [boolean $debug = False], CMS_PAGE $obj_page)
 array getDefaultProjRow ([boolean $debug = False])
 array getMenuChildrenRowArray (string $aKey, [boolean $debug = False])
 array getMenuRow (string $aKey, [boolean $debug = False])
 void getPageChapters ( $pagId, [ $langId = 0], [ $debug = False])
 void getPageFromEnv ([boolean $debug = False])
 array getPageRow (int $aPagId, [boolean $debug = False])
 array getProjRow (int $aId, [boolean $debug = False])
 array getServerProjRow ([boolean $debug = False])
 void setPageChapters ( $chapters, [ $langId = 0], [ $debug = False])
 void storeMenuObj (CMS_MENU_NODE $menuObj, [boolean $debug = False])
 void storePage (CMS_PAGE $pageObj, [boolean $debug = False])
Variables
static string $cacheSubDirName = 'ocsp_cms' (line 51)

cache subdir

  • access: protected

Redefinition of:
OCSP_CACHE_FILE::$cacheSubDirName
cache subdir

Inherited Variables

Inherited from OCSP_CACHE_FILE

OCSP_CACHE_FILE::$fileLoaded

Inherited from OCSP_CACHE

OCSP_CACHE::$cacheInstances
OCSP_CACHE::$myGroup
OCSP_CACHE::$myValues
Methods
static getInstance (line 69)

returns the instance of the singleton class

  • access: public
OCSP_CMS_CACHE getInstance ([string $group = '_NOT_USED_HERE_'])
  • string $group: // ignored here this is replaced with $_SERVER['SERVERNAME'±

Redefinition of:
OCSP_CACHE_FILE::getInstance()
returns the instance of the singleton class
clearPageCache (line 209)

clears the page cache for $obj_page

  • access: public
void clearPageCache ( $pageObj, [boolean $debug = False], CMS_PAGE $obj_page)
  • CMS_PAGE $obj_page
  • boolean $debug
  • $pageObj
getDefaultProjRow (line 117)

returns the project row of the default project

  • access: public
array getDefaultProjRow ([boolean $debug = False])
  • boolean $debug
getMenuChildrenRowArray (line 147)

returns an array with children keys of menu with key $aKey

  • access: public
array getMenuChildrenRowArray (string $aKey, [boolean $debug = False])
  • string $aKey
  • boolean $debug
getMenuRow (line 134)

returns the cache menu row

  • access: public
array getMenuRow (string $aKey, [boolean $debug = False])
  • string $aKey
  • boolean $debug
getPageChapters (line 216)

* page methods -------------------------------------------------

  • access: public
void getPageChapters ( $pagId, [ $langId = 0], [ $debug = False])
  • $pagId
  • $langId
  • $debug
getPageFromEnv (line 173)

tries to get a page object from the environment

  • access: public
void getPageFromEnv ([boolean $debug = False])
  • boolean $debug
getPageRow (line 186)

returns the cached page row (if found)

  • return: | Null
  • access: public
array getPageRow (int $aPagId, [boolean $debug = False])
  • int $aPagId
  • boolean $debug
getProjRow (line 93)

returns the project row

  • access: public
array getProjRow (int $aId, [boolean $debug = False])
  • int $aId
  • boolean $debug
getServerProjRow (line 105)

returns the project row for $_SERVER['SERVER_NAME']

  • access: public
array getServerProjRow ([boolean $debug = False])
  • boolean $debug
setPageChapters (line 221)
  • access: public
void setPageChapters ( $chapters, [ $langId = 0], [ $debug = False])
  • $chapters
  • $langId
  • $debug
storeMenuObj (line 158)

stores a menu node to the cache

  • access: public
void storeMenuObj (CMS_MENU_NODE $menuObj, [boolean $debug = False])
storePage (line 198)

stores a page to the cache

  • access: public
void storePage (CMS_PAGE $pageObj, [boolean $debug = False])

Inherited Methods

Inherited From OCSP_CACHE_FILE

 OCSP_CACHE_FILE::getCacheFilePath()
 OCSP_CACHE_FILE::getInstance()
 OCSP_CACHE_FILE::getStoredValueArr()
 OCSP_CACHE_FILE::isUseable()
 OCSP_CACHE_FILE::loadMyValues()
 OCSP_CACHE_FILE::storeMyValues()
 OCSP_CACHE_FILE::unsetValue()

Inherited From OCSP_CACHE

 OCSP_CACHE::__construct()
 OCSP_CACHE::getValue()
 OCSP_CACHE::setValue()
 OCSP_CACHE::__destruct()
Class Constants
CLASS_SRC_FILE = __FILE__ (line 43)
  • abstract:

Inherited Constants

Inherited from OCSP_CACHE_FILE

OCSP_CACHE_FILE::CLASS_SRC_FILE

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