Docs For Class OCSP_CMS

OCSP_CMS_PEARCACHE

Description

Class OCSP_CMS_PEARCACHE.phpclass

author: Peter Krebs <pitlinz@users.sourceforge.net>
see: http://pear.php.net/manual/en/package.caching.cache-lite.php
requires: Cache/Lite.php [PEAR]
since: pk-07-06-07
project: Open CSP-Management
license: GNU Public License
uses: $GLOBALS['OCSP']['OBJCACHEPATH']

Located in /cms/OCSP_CMS_PEARCACHE.phpclass (line 53)

Variable Summary

array $menNodeValsLoaded

string $menuTreeIndex

Cache_Lite $myMenuCache

Cache_Lite $myPageCache

array $projCachArr

string $rootPath

int $ttl

Method Summary

OCSP_CMS_PEARCACHE OCSP_CMS_PEARCACHE ()

void addProjIdFromHTTP_HOST (int $aId, [string $aHost = ""], [string $urlRegex = ""], [ $aServerName = ""])

void cleanProject (CMS_PROJECT $aProject, [boolean $debug = FALSE])

void clearProjIdFromHTTP_HOST ([boolean $debug = FALSE])

void &getMenuCacheObj ([boolean $chkDir = FALSE], [boolean $debug = FALSE])

array getMenuCacheOptions ([boolean $chkDir = FALSE], [boolean $debug = FALSE])

mixed getMenuData ( $aId, [boolean $debug = FALSE], int $pag_id)

boolean getMenuKeyTree (int $projId, [ $debug = FALSE], string $treeKey)

boolean getMenuNodesVal (int $projId, [ $debug = FALSE], string $treeKey)

array getMenuPageListVal (mixed $aId, [boolean $debug = FALSE])

mixed getMenuVal (int $aId, [boolean $debug = FALSE])

void &getPageCacheObj ([boolean $chkDir = FALSE], [boolean $debug = FALSE])

array getPageCacheOptions ([boolean $chkDir = FALSE], [boolean $debug = FALSE])

mixed getPageData ( $aId, [boolean $debug = FALSE], int $pag_id)

string getPageHeader (CMS_PAGE_V2 $pageObj, [boolean $debug = FALSE])

array getPageTmplRow (int $projId, $tmplId, [boolean $debug = FALSE], int $pageId)

mixed getPageVal (int $aId, [boolean $debug = FALSE])

Cache_Lite &getProjCacheObj (int $projId, [boolean $chkDir = FALSE], [boolean $debug = FALSE])

array getProjCssArray (int $projId, [boolean $debug = FALSE])

array getProjDBValues (int $projId, [boolean $debug = FALSE])

int getProjIdFromHTTP_HOST ([boolean $debug = FALSE])

string getRootPath ()

boolean menuNodesValLoaded (int $projId, [string $menuTreeIndex = 'T_CMS_MENU'])

boolean setMenuData ( &$aNode, [boolean $debug = FALSE], CMS_PAGE_V2 $aPage)

void setMenuKeyTree ( $projId, $keyArr, [boolean $debug = FALSE], CMS_PROJECT $aProj)

array setMenuPageListVal (mixed $aId, $arr_cache, [boolean $debug = FALSE])

void setMenuTreeIndex (string $treeName)

boolean setPageData ( &$aPage, [boolean $debug = FALSE], CMS_PAGE_V2 $aPage)

array setPageTmplRow (int $projId, $tmplId, $tmplRow, [boolean $debug = FALSE], int $pageId, array $pageRow)

array setProjCssArray (int $projId, $cssArr, [boolean $debug = FALSE])

void setProjDBValues (CMS_PROJECT $aProj, [boolean $debug = FALSE])

Variables

array $menNodeValsLoaded = array() (line 111)

var: ([$menuTreeIndex]=TRUE/FALSE)
access: protected

string $menuTreeIndex = "" (line 105)

index of the menu tree in $GLOBALS['OCSP_VAL']['DBMS_TREE']

access: protected

Cache_Lite $myMenuCache = NULL (line 73)

access: protected

Cache_Lite $myPageCache = NULL (line 79)

access: protected

array $projCachArr = array() (line 67)

access: protected

string $rootPath = "" (line 89)

access: protected

int $ttl = 604800 (line 95)

access: protected

Methods

Constructor OCSP_CMS_PEARCACHE (line 122)

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

Constructors

OCSP_CMS_PEARCACHE OCSP_CMS_PEARCACHE ()

addProjIdFromHTTP_HOST (line 675)

adds or replaces a host if $aId is 0 the host is removed from the cache

access: public

void addProjIdFromHTTP_HOST (int $aId, [string $aHost = ""], [string $urlRegex = ""], [ $aServerName = ""])

int $aId: (0 -> unset the cache object)
string $aHost
string $urlRegex
$aServerName

cleanProject (line 235)

clears the cache by removing the cache directory

access: public

void cleanProject (CMS_PROJECT $aProject, [boolean $debug = FALSE])

CMS_PROJECT $aProject
boolean $debug

clearProjIdFromHTTP_HOST (line 717)

access: public

void clearProjIdFromHTTP_HOST ([boolean $debug = FALSE])

boolean $debug

getMenuCacheObj (line 281)

void &getMenuCacheObj ([boolean $chkDir = FALSE], [boolean $debug = FALSE])

boolean $chkDir
boolean $debug

getMenuCacheOptions (line 254)

array getMenuCacheOptions ([boolean $chkDir = FALSE], [boolean $debug = FALSE])

boolean $chkDir: (if true the existens of page cache dir is checked)
boolean $debug

getMenuData (line 309)

returns an array with all data for a menu node

array(
'MENVAL' => CMS_MENU_NODE->getDBVal(),
'PROJVAL'=> CMS_PROJECT->getDBVal()
)

return: array or false if cache failed

mixed getMenuData ( $aId, [boolean $debug = FALSE], int $pag_id)

int $pag_id
boolean $debug
$aId

getMenuKeyTree (line 832)

boolean getMenuKeyTree (int $projId, [ $debug = FALSE], string $treeKey)

int $projId
string $treeKey
$debug

getMenuNodesVal (line 884)

sets the global environment of the tree from the cache

boolean getMenuNodesVal (int $projId, [ $debug = FALSE], string $treeKey)

int $projId
string $treeKey
$debug

getMenuPageListVal (line 387)

array getMenuPageListVal (mixed $aId, [boolean $debug = FALSE])

mixed $aId: (int) menu id or (string) PROJ_$*PROJ_ID$ for project root pages
boolean $debug

getMenuVal (line 330)

returns an array with page values

return: array of false if cache failed

mixed getMenuVal (int $aId, [boolean $debug = FALSE])

int $aId
boolean $debug

getPageCacheObj (line 468)

void &getPageCacheObj ([boolean $chkDir = FALSE], [boolean $debug = FALSE])

boolean $chkDir
boolean $debug

getPageCacheOptions (line 441)

array getPageCacheOptions ([boolean $chkDir = FALSE], [boolean $debug = FALSE])

boolean $chkDir: (if true the existens of page cache dir is checked)
boolean $debug

getPageData (line 497)

returns an array with all data for a page

array(
'PAGVAL' => CMS_PAGE_V2->getDBVal(),
'MENVAL' => CMS_MENU_NODE->getDBVal(),
'PROJVAL'=> CMS_PROJECT->getDBVal()
)

return: array or false if cache failed

mixed getPageData ( $aId, [boolean $debug = FALSE], int $pag_id)

int $pag_id
boolean $debug
$aId

getPageHeader (line 964)

access: public

string getPageHeader (CMS_PAGE_V2 $pageObj, [boolean $debug = FALSE])

CMS_PAGE_V2 $pageObj
boolean $debug

getPageTmplRow (line 781)

access: public

array getPageTmplRow (int $projId, $tmplId, [boolean $debug = FALSE], int $pageId)

int $projId
int $pageId
boolean $debug
$tmplId

getPageVal (line 518)

returns an array with page values

return: array of false if cache failed

mixed getPageVal (int $aId, [boolean $debug = FALSE])

int $aId
boolean $debug

getProjCacheObj (line 165)

requires: $GLOBALS['OCSP']['PHPINCPATH']."common/pcf_directory.phpinc";
access: public

Cache_Lite &getProjCacheObj (int $projId, [boolean $chkDir = FALSE], [boolean $debug = FALSE])

int $projId
boolean $chkDir
boolean $debug

getProjCssArray (line 738)

access: public

array getProjCssArray (int $projId, [boolean $debug = FALSE])

int $projId
boolean $debug

getProjDBValues (line 201)

gets a projects database values from the cache

array getProjDBValues (int $projId, [boolean $debug = FALSE])

int $projId
boolean $debug

getProjIdFromHTTP_HOST (line 617)

access: public

int getProjIdFromHTTP_HOST ([boolean $debug = FALSE])

boolean $debug

getRootPath (line 138)

string getRootPath ()

menuNodesValLoaded (line 867)

returns if the global menu nodeval array has been loaded

access: public

boolean menuNodesValLoaded (int $projId, [string $menuTreeIndex = 'T_CMS_MENU'])

int $projId
string $menuTreeIndex

setMenuData (line 355)

sets page cache values

boolean setMenuData ( &$aNode, [boolean $debug = FALSE], CMS_PAGE_V2 $aPage)

CMS_PAGE_V2 $aPage
boolean $debug
&$aNode

setMenuKeyTree (line 845)

stores a projects database values to the cache

void setMenuKeyTree ( $projId, $keyArr, [boolean $debug = FALSE], CMS_PROJECT $aProj)

CMS_PROJECT $aProj
boolean $debug
$projId
$keyArr

setMenuPageListVal (line 406)

array setMenuPageListVal (mixed $aId, $arr_cache, [boolean $debug = FALSE])

mixed $aId: (int) menu id or (string) PROJ_$*PROJ_ID$ for project root pages
boolean $debug
$arr_cache

setMenuTreeIndex (line 820)

sets the menuTreeKey (index of $GLOBALS['OCSP_VAL']['DBMS_TREE'][$this->menuTreeIndex])

access: public

void setMenuTreeIndex (string $treeName)

string $treeName

setPageData (line 543)

sets page cache values

boolean setPageData ( &$aPage, [boolean $debug = FALSE], CMS_PAGE_V2 $aPage)

CMS_PAGE_V2 $aPage
boolean $debug
&$aPage

setPageTmplRow (line 798)

access: public

array setPageTmplRow (int $projId, $tmplId, $tmplRow, [boolean $debug = FALSE], int $pageId, array $pageRow)

int $projId
int $pageId
array $pageRow
boolean $debug
$tmplId
$tmplRow

setProjCssArray (line 754)

access: public

array setProjCssArray (int $projId, $cssArr, [boolean $debug = FALSE])

int $projId
boolean $debug
$cssArr

setProjDBValues (line 214)

stores a projects database values to the cache

void setProjDBValues (CMS_PROJECT $aProj, [boolean $debug = FALSE])

CMS_PROJECT $aProj
boolean $debug

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