abstract class OCSP_FRMCONTR_CACHEDLIST

• author: Peter Krebs (pk) <pitlinz@users.sourceforge.net>
• version: $Id: OCSP_FRMCONTR.phpclass,v 1.33 2008/12/17 16:28:51 peterkrebs Exp $
• version: pk-08-01-21 // extends OCSP_OBJ
• abstract:
• since: pk-08-01-19 *
• project: Open CSP-Management
• license: GNU Public License

Located in /db/forms/OCSP_FRMCONTR_CACHEDLIST.phpclass (line 32)

OCSP_OBJ
   |
   --OCSP_FRMCONTR
      |
      --OCSP_FRMCONTR_LIST
         |
         --OCSP_FRMCONTR_CACHEDLIST

int $cacheRowTTL = 300 (line 73)

ttl of the storage result

• access: protected

int $fillTime (line 66)

systemtime when the rows where last filled from the storage

• access: protected

string $myCacheKey = "" (line 59)

hashKey to identify the list in the cache

• access: protected

array $myCacheRows = array() (line 83)

array holding all rows

• access: protected

Inherited Variables

Inherited from OCSP_FRMCONTR_LIST

OCSP_FRMCONTR_LIST::$listLoadTS
OCSP_FRMCONTR_LIST::$lstObjValCols
OCSP_FRMCONTR_LIST::$lstObjValTS
OCSP_FRMCONTR_LIST::$lstQuery
OCSP_FRMCONTR_LIST::$lstTables
OCSP_FRMCONTR_LIST::$lst_groupValues
OCSP_FRMCONTR_LIST::$lst_limit
OCSP_FRMCONTR_LIST::$lst_offset
OCSP_FRMCONTR_LIST::$lst_orderBy
OCSP_FRMCONTR_LIST::$lst_pageingUrl
OCSP_FRMCONTR_LIST::$myListIdx
OCSP_FRMCONTR_LIST::$myListKey
OCSP_FRMCONTR_LIST::$myListValues
OCSP_FRMCONTR_LIST::$myRowCmds
OCSP_FRMCONTR_LIST::$tbl_footerCmds
OCSP_FRMCONTR_LIST::$tbl_rowBtnCmds
OCSP_FRMCONTR_LIST::$tbl_sortLink

Inherited from OCSP_FRMCONTR

OCSP_FRMCONTR::$checkRights_hasDBRightsSet
OCSP_FRMCONTR::$checkRights_userRights
OCSP_FRMCONTR::$curRow
OCSP_FRMCONTR::$myActionURL
OCSP_FRMCONTR::$myCommands
OCSP_FRMCONTR::$myDBObj
OCSP_FRMCONTR::$myFilter
OCSP_FRMCONTR::$myForm
OCSP_FRMCONTR::$myjOCSPHash
OCSP_FRMCONTR::$myReloadUrl
OCSP_FRMCONTR::$myView
OCSP_FRMCONTR::$rowPopulateTS
OCSP_FRMCONTR::$userCanShowMethod

Inherited from OCSP_OBJ

OCSP_OBJ::$global_currentUser
OCSP_OBJ::$global_defaultDBObj_read
OCSP_OBJ::$global_defaultDBObj_write
OCSP_OBJ::$staticClassVars

static factoryCachedList (line 207)

factory a new cached list controll

• access: public

OCSP_FRMCONTR_CACHEDLIST factoryCachedList (int $aCacheType,  $aHashKey, [boolean $debug = FALSE])

• int $aCacheType
• boolean $debug
• $aHashKey

static factoryNewByCacheType (line 154)

factory a new cached list controll

• access: public

OCSP_FRMCONTR_CACHEDLIST factoryNewByCacheType (int $aCacheType, [boolean $debug = FALSE])

• int $aCacheType
• boolean $debug

static includeCacheClass (line 99)

includes the propper cache class and returns the class name

• access: public

string includeCacheClass (unknown_type $aCacheType, [unknown_type $debug = FALSE])

• unknown_type $aCacheType
• unknown_type $debug

cacheIsFilled (line 377)

return of the cache has been filled from the storage ($this->fillTime)

• access: public

boolean cacheIsFilled ()

cacheIsValid (line 365)

returns if the cache is valid and not outtimed

• abstract:
• access: public

boolean cacheIsValid ()

---

Redefined in descendants as:

• OCSP_FRMCONTR_CACHEDLIST_APC::cacheIsValid() : returns if the cache is valid and not outtimed
• OCSP_FRMCONTR_CACHEDLIST_PEAR::cacheIsValid() : returns if the cache is valid and not outtimed

fillCache (line 412)

loads the values from the storage into $this->myCachedRows and cache $this->myCachedRows

• abstract:
• access: public

boolean fillCache ([boolan $debug = FALSE])

• boolan $debug

---

Redefined in descendants as:

• OCSP_FRMCONTR_CACHEDLIST_APC::fillCache() : loads the values from the storage into $this->myCachedRows and cache $this->myCachedRows
• OCSP_FRMCONTR_CACHEDLIST_PEAR::fillCache() : loads the values from the storage into $this->myCachedRows and cache $this->myCachedRows

generateMyCacheKey (line 268)

generates and returns the cacheKey

if none is set a new one is created

string generateMyCacheKey ([boolean $debug = FALSE])

• boolean $debug

getCacheDesc (line 334)

returns a desc array if cached

• abstract:
• access: public

array getCacheDesc ([string $cacheKey = NULL])

• string $cacheKey

---

Redefined in descendants as:

• OCSP_FRMCONTR_CACHEDLIST_PEAR::getCacheDesc() : returns a desc array if cached

getCachedValues (line 397)

loads the cached values into $this->myCachedRows or filles the cache if this has not happend

• abstract:
• access: public

boolean getCachedValues ([boolean $debug = FALSE])

• boolean $debug

---

Redefined in descendants as:

• OCSP_FRMCONTR_CACHEDLIST_APC::getCachedValues() : loads the cached values into $this->myCachedRows or filles the cache if this has not happend
• OCSP_FRMCONTR_CACHEDLIST_PEAR::getCachedValues() : loads the cached values into $this->myCachedRows or filles the cache if this has not happend

getCacheType (line 248)

returns the cache type used

• return: (_OCSP_CACHE_* constant value)

int getCacheType ()

getMyCacheKey (line 295)

returns the hash key to identify the cache

string getMyCacheKey ()

getNbrOfCachedRows (line 353)

returns the size of the cache array

• access: public

int getNbrOfCachedRows ()

loadListValues (line 423)

void loadListValues ([ $debug = FALSE])

• $debug

---

Redefinition of:

OCSP_FRMCONTR_LIST::loadListValues()

loads the list values from the database to $this->myListValues an always sets $this->listLoadTS to time()

saveCacheDesc (line 320)

caches the description

• abstract:
• access: public

void saveCacheDesc ()

---

Redefined in descendants as:

• OCSP_FRMCONTR_CACHEDLIST_PEAR::saveCacheDesc() : caches the description

setCacheDesc (line 339)

• access: public

void setCacheDesc ( $aDescArr)

• $aDescArr

setMyCacheKey (line 305)

set the hash key to identify the cache

void setMyCacheKey (string $aHashKey)

• string $aHashKey

Inherited Methods

Inherited From OCSP_FRMCONTR_LIST

OCSP_FRMCONTR_LIST::addCmdButton()
OCSP_FRMCONTR_LIST::addFooterCommand()
OCSP_FRMCONTR_LIST::checkAutopageing()
OCSP_FRMCONTR_LIST::getCmdButtons()
OCSP_FRMCONTR_LIST::getColCmd()
OCSP_FRMCONTR_LIST::getColLink()
OCSP_FRMCONTR_LIST::getColLinkEnd()
OCSP_FRMCONTR_LIST::getFilterWhere()
OCSP_FRMCONTR_LIST::getFooterLinks()
OCSP_FRMCONTR_LIST::getHeadColEvents()
OCSP_FRMCONTR_LIST::getHeadRowEvents()
OCSP_FRMCONTR_LIST::getLimit()
OCSP_FRMCONTR_LIST::getListGroups()
OCSP_FRMCONTR_LIST::getListKey()
OCSP_FRMCONTR_LIST::getListQuery()
OCSP_FRMCONTR_LIST::getListRow()
OCSP_FRMCONTR_LIST::getListValues()
OCSP_FRMCONTR_LIST::getNofBtnCols()
OCSP_FRMCONTR_LIST::getNofListRows()
OCSP_FRMCONTR_LIST::getNofTotalRows()
OCSP_FRMCONTR_LIST::getOffset()
OCSP_FRMCONTR_LIST::getOrderBy()
OCSP_FRMCONTR_LIST::getPageingBackButton()
OCSP_FRMCONTR_LIST::getPageingNext()
OCSP_FRMCONTR_LIST::getRowButtons()
OCSP_FRMCONTR_LIST::getRowCmd()
OCSP_FRMCONTR_LIST::getRowId()
OCSP_FRMCONTR_LIST::getTableEvents()
OCSP_FRMCONTR_LIST::getTableId()
OCSP_FRMCONTR_LIST::initList()
OCSP_FRMCONTR_LIST::invalidateValues()
OCSP_FRMCONTR_LIST::loadListObjectValues()
OCSP_FRMCONTR_LIST::loadListValues()
OCSP_FRMCONTR_LIST::setFooterCmdArr()
OCSP_FRMCONTR_LIST::setLimit()
OCSP_FRMCONTR_LIST::setListKey()
OCSP_FRMCONTR_LIST::setListQuery()
OCSP_FRMCONTR_LIST::setOffset()
OCSP_FRMCONTR_LIST::setOrderBy()
OCSP_FRMCONTR_LIST::setRowCmd()
OCSP_FRMCONTR_LIST::valuesAreLoaded()

Inherited From OCSP_FRMCONTR

OCSP_FRMCONTR::__construct()
OCSP_FRMCONTR::addFilter()
OCSP_FRMCONTR::checkRights()
OCSP_FRMCONTR::getActionURL()
OCSP_FRMCONTR::getAjaxObj()
OCSP_FRMCONTR::getCurrentRow()
OCSP_FRMCONTR::getCurRow()
OCSP_FRMCONTR::getCurValue()
OCSP_FRMCONTR::getDBObj()
OCSP_FRMCONTR::getFilter()
OCSP_FRMCONTR::getMyForm()
OCSP_FRMCONTR::getObjectValues()
OCSP_FRMCONTR::getReloadUrl()
OCSP_FRMCONTR::getView()
OCSP_FRMCONTR::jOCSP_getfrmHash()
OCSP_FRMCONTR::jOCSP_setfrmHash()
OCSP_FRMCONTR::parseFieldTmpl()
OCSP_FRMCONTR::parseRowTmpl()
OCSP_FRMCONTR::populateRow()
OCSP_FRMCONTR::rowIsPopulated()
OCSP_FRMCONTR::saveCurRow()
OCSP_FRMCONTR::setActionURL()
OCSP_FRMCONTR::setAjaxObj()
OCSP_FRMCONTR::setCommand()
OCSP_FRMCONTR::setCurRow()
OCSP_FRMCONTR::setCurRowValue()
OCSP_FRMCONTR::setFilter()
OCSP_FRMCONTR::setMyForm()
OCSP_FRMCONTR::setObjectValues()
OCSP_FRMCONTR::setReloadUrl()
OCSP_FRMCONTR::setView()
OCSP_FRMCONTR::set_userCanShowMethod()
OCSP_FRMCONTR::unsetFilter()
OCSP_FRMCONTR::validateBlockSubmit()
OCSP_FRMCONTR::validateSubmit()

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

_MY_FRMLIST_CACHETYPE_ = 0 (line 43)

type of the cache used

• abstract:

Inherited Constants

Inherited from OCSP_OBJ

OCSP_OBJ::CLASS_SRC_FILE