<?php /** * TSqlMapCache class file contains FIFO, LRU, and GLOBAL cache implementations. * * @author Wei Zhuo <weizhuo[at]gmail[dot]com> * @link http://www.pradosoft.com/ * @copyright Copyright © 2005-2013 PradoSoft * @license http://www.pradosoft.com/license/ * @version $Id: TSqlMapCache.php 3245 2013-01-07 20:23:32Z ctrlaltca $ * @package System.Data.SqlMap */ /** * Allow different implementation of caching strategy. See <tt>TSqlMapFifoCache</tt> * for a first-in-first-out implementation. See <tt>TSqlMapLruCache</tt> for * a least-recently-used cache implementation. * * @author Wei Zhuo <weizhuo[at]gmail[dot]com> * @version $Id: TSqlMapCache.php 3245 2013-01-07 20:23:32Z ctrlaltca $ * @package System.Data.SqlMap * @since 3.1 */ abstract class TSqlMapCache implements ICache { protected $_keyList; protected $_cache; protected $_cacheSize = 100; protected $_cacheModel = null; /** * Create a new cache with limited cache size. * @param TSqlMapCacheModel $cacheModel. */ public function __construct($cacheModel=null) { $this->_cache = new TMap; $this->_keyList = new TList; $this->_cacheModel=$cacheModel; } /** * Maximum number of items to cache. Default size is 100. * @param int cache size. */ public function setCacheSize($value) { $this->_cacheSize=TPropertyValue::ensureInteger($value,100); } /** * @return int cache size. */ public function getCacheSize() { return $this->_cacheSize; } /** * @return object the object removed if exists, null otherwise. */ public function delete($key) { $object = $this->get($key); $this->_cache->remove($key); $this->_keyList->remove($key); return $object; } /** * Clears the cache. */ public function flush() { $this->_keyList->clear(); $this->_cache->clear(); } /** * @throws TSqlMapException not implemented. */ public function add($id,$value,$expire=0,$dependency=null) { throw new TSqlMapException('sqlmap_use_set_to_store_cache'); } } /** * First-in-First-out cache implementation, removes * object that was first added when the cache is full. * * @author Wei Zhuo <weizhuo[at]gmail[dot]com> * @version $Id: TSqlMapCache.php 3245 2013-01-07 20:23:32Z ctrlaltca $ * @package System.Data.SqlMap * @since 3.1 */ class TSqlMapFifoCache extends TSqlMapCache { /** * @return mixed Gets a cached object with the specified key. */ public function get($key) { return $this->_cache->itemAt($key); } /** * Stores a value identified by a key into cache. * The expire and dependency parameters are ignored. * @param string cache key * @param mixed value to cache. */ public function set($key, $value,$expire=0,$dependency=null) { $this->_cache->add($key, $value); $this->_keyList->add($key); if($this->_keyList->getCount() > $this->_cacheSize) { $oldestKey = $this->_keyList->removeAt(0); $this->_cache->remove($oldestKey); } } } /** * Least recently used cache implementation, removes * object that was accessed last when the cache is full. * * @author Wei Zhuo <weizhuo[at]gmail[dot]com> * @version $Id: TSqlMapCache.php 3245 2013-01-07 20:23:32Z ctrlaltca $ * @package System.Data.SqlMap * @since 3.1 */ class TSqlMapLruCache extends TSqlMapCache { /** * @return mixed Gets a cached object with the specified key. */ public function get($key) { if($this->_keyList->contains($key)) { $this->_keyList->remove($key); $this->_keyList->add($key); return $this->_cache->itemAt($key); } } /** * Stores a value identified by a key into cache. * The expire and dependency parameters are ignored. * @param string the key identifying the value to be cached * @param mixed the value to be cached */ public function set($key, $value,$expire=0,$dependency=null) { $this->_cache->add($key, $value); $this->_keyList->add($key); if($this->_keyList->getCount() > $this->_cacheSize) { $oldestKey = $this->_keyList->removeAt(0); $this->_cache->remove($oldestKey); } } } /** * TSqlMapApplicationCache uses the default Prado application cache for * caching SqlMap results. * * @author Wei Zhuo <weizho[at]gmail[dot]com> * @version $Id: TSqlMapCache.php 3245 2013-01-07 20:23:32Z ctrlaltca $ * @package System.Data.SqlMap * @since 3.1 */ class TSqlMapApplicationCache implements ICache { protected $_cacheModel=null; /** * Create a new cache with limited cache size. * @param TSqlMapCacheModel $cacheModel. */ public function __construct($cacheModel=null) { $this->_cacheModel=$cacheModel; } /** * * @return string a KeyListID for the cache model. */ protected function getKeyListId() { $id='keyList'; if ($this->_cacheModel instanceof TSqlMapCacheModel) $id.='_'.$this->_cacheModel->getId(); return $id; } /** * Retreive keylist from cache or create it if it doesn't exists * @return TList */ protected function getKeyList() { if (($keyList=$this->getCache()->get($this->getKeyListId()))===false) { $keyList=new TList(); $this->getCache()->set($this->getKeyListId(), $keyList); } return $keyList; } protected function setKeyList($keyList) { $this->getCache()->set($this->getKeyListId(), $keyList); } /** * @param string item to be deleted. */ public function delete($key) { $keyList=$this->getKeyList(); $keyList->remove($key); $this->getCache()->delete($key); $this->setKeyList($keyList); } /** * Deletes all items in the cache, only for data cached by sqlmap cachemodel */ public function flush() { $keyList=$this->getKeyList(); $cache=$this->getCache(); foreach ($keyList as $key) { $cache->delete($key); } // Remove the old keylist $cache->delete($this->getKeyListId()); } /** * @return mixed Gets a cached object with the specified key. */ public function get($key) { $result = $this->getCache()->get($key); if ($result === false) { // if the key has not been found in cache (e.g expired), remove from keylist $keyList=$this->getKeyList(); if ($keyList->contains($key)) { $keyList->remove($key); $this->setKeyList($keyList); } } return $result === false ? null : $result; } /** * Stores a value identified by a key into cache. * @param string the key identifying the value to be cached * @param mixed the value to be cached */ public function set($key, $value,$expire=0,$dependency=null) { $this->getCache()->set($key, $value, $expire,$dependency); $keyList=$this->getKeyList(); if (!$keyList->contains($key)) { $keyList->add($key); $this->setKeyList($keyList); } } /** * @return ICache Application cache instance. */ protected function getCache() { return Prado::getApplication()->getCache(); } /** * @throws TSqlMapException not implemented. */ public function add($id,$value,$expire=0,$dependency=null) { throw new TSqlMapException('sqlmap_use_set_to_store_cache'); } }