File Source for OCSP_FRMCONTR_CACHEDLIST.phpclass

<?php
/**
* Class file OCSP_FRMCONTR_CACHEDLIST_APC.phpclass
*
*
* @project Open CSP-Management
* @package forms
* @category dbms_form
*
* @author Peter Krebs (pk) <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-08-01-19
*
***/
require_once dirname(__FILE__)._OCSP_DIRSEP_."OCSP_FRMCONTR_LIST.phpclass";
/**
* abstract class OCSP_FRMCONTR_CACHEDLIST
*
* @project Open CSP-Management
* @package forms
* @category dbms_form
*
* @author Peter Krebs (pk) <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-08-01-19
* *
*/
abstract class OCSP_FRMCONTR_CACHEDLIST extends OCSP_FRMCONTR_LIST
{
/*** class constants --------------------------------------------- */
/**
* type of the cache used
*
* @constant int _MY_FRMLIST_CACHETYPE_
* @abstract
*
*/
const _MY_FRMLIST_CACHETYPE_=0;
/*** class variables --------------------------------------------- */
/*** compositions ------------------------------------------------ */
/*** aggregation -------------------------------------------------- */
/*** attributes --------------------------------------------------- */
/**
* hashKey to identify the list in the cache
*
* @var string $myCacheKey
*/
protected $myCacheKey="";
/**
* systemtime when the rows where last filled from the storage
*
* @var int $fillTime
*/
protected $fillTime=0;
/**
* ttl of the storage result
*
* @var int
*/
protected $cacheRowTTL =300; // 5 minutes
/**
* array holding all rows
*
* @var array $myCacheRows
*/
protected $myCacheRows=array();
/**
*
* FACTORY _____________________________________________
*
*/
/**
* includes the propper cache class and returns the class name
*
* @param unknown_type $aCacheType
* @param unknown_type $debug
*
* @return string
*/
public static function includeCacheClass($aCacheType,$debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,"static","OCSP_FRMCONTR_CACHEDLIST::loadCacheClass");
switch($aCacheType)
{
case _OCSP_CACHE_MEMCACHE_:
if (!class_exists('OCSP_FRMCONTR_CACHEDLIST_MEMCACHE'))
{
require_once dirname(__FILE__)._OCSP_DIRSEP_."OCSP_FRMCONTR_CACHEDLIST_MEMCACHE.phpclass";
}
return "OCSP_FRMCONTR_CACHEDLIST_MEMCACHE";
case _OCSP_CACHE_APC_:
if (!class_exists('OCSP_FRMCONTR_CACHEDLIST_APC'))
{
require_once dirname(__FILE__)._OCSP_DIRSEP_."OCSP_FRMCONTR_CACHEDLIST_APC.phpclass";
}
return "OCSP_FRMCONTR_CACHEDLIST_APC";
case _OCSP_CACHE_PEAR_:
if (!class_exists('Cache_Lite'))
{
require_once "Cache/Lite.php";
}
if (!class_exists('OCSP_FRMCONTR_CACHEDLIST_PEAR'))
{
require_once dirname(__FILE__)._OCSP_DIRSEP_."OCSP_FRMCONTR_CACHEDLIST_PEAR.phpclass";
}
return "OCSP_FRMCONTR_CACHEDLIST_PEAR";
case _OCSP_CACHE_DB_:
if (!class_exists('OCSP_FRMCONTR_CACHEDLIST_DB'))
{
require_once dirname(__FILE__)._OCSP_DIRSEP_."OCSP_FRMCONTR_CACHEDLIST_DB.phpclass";
}
return "OCSP_FRMCONTR_CACHEDLIST_DB";
case _OCSP_CACHE_SESSION_:
if (!class_exists('OCSP_FRMCONTR_CACHEDLIST_SESSION'))
{
require_once dirname(__FILE__)._OCSP_DIRSEP_."OCSP_FRMCONTR_CACHEDLIST_SESSION.phpclass";
}
return "OCSP_FRMCONTR_CACHEDLIST_SESSION";
default:
return NULL;
}
}
/**
* factory a new cached list controll
*
* @param int $aCacheType
* @param boolean $debug
*
* @return OCSP_FRMCONTR_CACHEDLIST
*/
public static function factoryNewByCacheType($aCacheType,$debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,"static","OCSP_FRMCONTR_CACHEDLIST::factoryCacheType");
switch($aCacheType)
{
case _OCSP_CACHE_MEMCACHE_:
if (!class_exists('OCSP_FRMCONTR_CACHEDLIST_MEMCACHE'))
{
require_once dirname(__FILE__)._OCSP_DIRSEP_."OCSP_FRMCONTR_CACHEDLIST_MEMCACHE.phpclass";
}
return new OCSP_FRMCONTR_CACHEDLIST_MEMCACHE();
case _OCSP_CACHE_APC_:
if (!class_exists('OCSP_FRMCONTR_CACHEDLIST_APC'))
{
require_once dirname(__FILE__)._OCSP_DIRSEP_."OCSP_FRMCONTR_CACHEDLIST_APC.phpclass";
}
return new OCSP_FRMCONTR_CACHEDLIST_APC();
case _OCSP_CACHE_PEAR_:
if (!class_exists('Cache_Lite'))
{
require_once "Cache/Lite.php";
}
if (!class_exists('OCSP_FRMCONTR_CACHEDLIST_PEAR'))
{
require_once dirname(__FILE__)._OCSP_DIRSEP_."OCSP_FRMCONTR_CACHEDLIST_PEAR.phpclass";
}
return new OCSP_FRMCONTR_CACHEDLIST_PEAR();
case _OCSP_CACHE_DB_:
if (!class_exists('OCSP_FRMCONTR_CACHEDLIST_DB'))
{
require_once dirname(__FILE__)._OCSP_DIRSEP_."OCSP_FRMCONTR_CACHEDLIST_DB.phpclass";
}
return new OCSP_FRMCONTR_CACHEDLIST_DB();
case _OCSP_CACHE_SESSION_:
if (!class_exists('OCSP_FRMCONTR_CACHEDLIST_SESSION'))
{
require_once dirname(__FILE__)._OCSP_DIRSEP_."OCSP_FRMCONTR_CACHEDLIST_SESSION.phpclass";
}
return new OCSP_FRMCONTR_CACHEDLIST_SESSION();
default:
return NULL;
}
}
/**
* factory a new cached list controll
*
* @param int $aCacheType
* @param boolean $debug
*
* @return OCSP_FRMCONTR_CACHEDLIST
*/
public static function factoryCachedList($aCacheType,$aHashKey,$debug=FALSE)
{
if ($obj_controll=OCSP_FRMCONTR_CACHEDLIST::factoryNewByCacheType($aCacheType))
{
if ($arr_desc=$obj_controll->getCacheDesc($aHashKey))
{
if ($debug) echo "alert('desc: ".pcf_js_escape(print_r($arr_desc,TRUE))."');";
if (intval($arr_desc['FORMID']))
{
$obj_form=OCSP_FORM::factory_from_id(intval($arr_desc['FORMID']));
$arr_settings=array('CONTROBJ' => &$obj_controll);
$obj_form->prepareList($arr_settings,$debug);
$obj_controll->setCacheDesc($arr_desc);
return $obj_controll;
}
}
}
return NULL;
}
/**
*
* METHODS _____________________________________________
*
*/
//---------------------------------------------------
// getter/setter
//---------------------------------------------------
/**
* returns the cache type used
*
* @return int (_OCSP_CACHE_* constant value)
*/
function getCacheType()
{
return $this->get_myClassConstant('_MY_FRMLIST_CACHETYPE_');
}
//---------------------------------------------------
// hash key
//---------------------------------------------------
/**
* generates and returns the cacheKey
*
* if none is set a new one is created
*
* @param boolean $debug
*
* @return string
*
*/
function generateMyCacheKey($debug=FALSE)
{
global $OCSP_OBJ;
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMCONTR_CACHE::generateMyHash()");
$str_hashVals = $this->getCacheType();
$str_hashVals.= "_::_".$this->myForm->getId();
$str_hashVals.= "_::_".serialize($this->myFilter);
$str_hashVals.= "_::_".serialize($this->lstTables);
$str_hashVals.= "_::_".$this->lst_orderBy;
$str_hashVals.= "_::_".$this->lst_groupValues;
$str_hashVals.= "_::_".$OCSP_OBJ['USER']->getId();
$str_hashVals.= "_::_".$OCSP_OBJ['USER']->getGroups();
if ($debug) echoDebugLine(__FILE__,__LINE__,"hash value string: ".$str_hashVals);
$this->myCacheKey=md5($str_hashVals);
return $this->myCacheKey;
}
/**
* returns the hash key to identify the cache
*
* @return string
*/
function getMyCacheKey()
{
return $this->myCacheKey;
}
/**
* set the hash key to identify the cache
*
* @param string $aHashKey
*/
function setMyCacheKey($aHashKey)
{
$this->myCacheKey=$aHashKey;
}
//---------------------------------------------------
// cache methods
//---------------------------------------------------
/**
* caches the description
*
* @abstract
*
*/
public function saveCacheDesc()
{
}
/**
* returns a desc array if cached
*
* @param string $cacheKey
*
* @return array
*
* @abstract
*/
public function getCacheDesc($cacheKey=NULL)
{
return NULL;
}
public function setCacheDesc($aDescArr)
{
$this->setListQuery($aDescArr['LISTQUERY']);
$this->setFilter($aDescArr['FORMFILTER']);
$this->setOrderBy($aDescArr['FORMORDERBY']);
$this->lst_groupValues=$aDescArr['FORMGROUPVALS'];
$this->fillTime=$aDescArr['CACHEFILLTIME'];
}
/**
* returns the size of the cache array
*
* @return int
*/
public function getNbrOfCachedRows()
{
return sizeof($this->myCacheRows);
}
/**
* returns if the cache is valid and not outtimed
*
* @return boolean
*
* @abstract
*/
public function cacheIsValid()
{
return FALSE;
}
/**
* return of the cache has been filled from the storage ($this->fillTime)
*
* @return boolean
*
*/
public function cacheIsFilled()
{
if ($this->cacheIsValied() && intval($this->fillTime))
{
return TRUE;
} else {
return FALSE;
}
}
/**
* loads the cached values into $this->myCachedRows
* or filles the cache if this has not happend
*
* @param boolean $debug
*
* @return boolean
*
* @abstract
*/
public function getCachedValues($debug=FALSE)
{
return FALSE;
}
/**
* loads the values from the storage into $this->myCachedRows
* and cache $this->myCachedRows
*
* @param boolan $debug
*
* @return boolean
*
* @abstract
*/
public function fillCache($debug=FALSE)
{
return FALSE;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// list db methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
function loadListValues($debug=FALSE)
{
if ($this->getCachedValues())
{
$int_maxCount = intval($this->getLimit());
if (intval($int_maxCount))
{
$i = $this->getOffset();
$int_count = 0;
$this->myListValues = array();
while(isset($this->myCacheRows[$i]) && ($int_count < $int_maxCount))
{
$this->myListValues[$int_count++] = $this->myCacheRows[$i++];
}
return $int_count;
} else {
$this->myListValues = $this->myCacheRows;
}
$this->myListIdx=0;
$this->listLoadTS=time();
return sizeof($this->myListValues);
} else {
if ($debug) echo "alert('could not get chached values');";
return FALSE;
}
}
}
?>

Source for file OCSP_FRMCONTR_CACHEDLIST.phpclass