Cache_lite Wrapper Class

Cache_lite is a very usefull PEAR library for implementing lightweight caching mechanisims. Two things it is capable of doing is;

* caching the return from any function
* caching any datastructure you pass to it.

One issue with Cache_lites implementation of these two capabilities is that they come from different classes. If you need to cache a function return, you need to require Cache/Lite/Function.php first. If you want to cache a data structure, you need to require Cache/Lite.php prior. Also the function caching syntax seemed a bit unintuative to me.
To aleviate these issues I wrote a smaller wrapper class that unifies and symplifies the usage of the Cache Lite class(es).

This allows the client code of cache wrapper to simply call getCall(), getData(), and saveData() without needing to know that different base CacheLite classes are involved.
Also I put in a bit of code to allow for a bit of leway on the accepted formatting of function string parameters given to getCall();
Example Usage

For any function you want to add 'cacheability' to, you can add an optional param of...

$cacheTTL = CachWrapper::DEFAULT_CACHE_TTL

You then code similar to the first two lines of the exaple method below. Note you can supply a cacheTTL of 0 to essentually make an un-cahced call to the method.
<br />public static function getCountries($cacheTTL = self::DEFAULT_CACHE_TTL) {<br /> $cache = new CacheWrapper($cacheTTL);<br /> /**<br /> * 'Webwizard::call_secure' is the function to call<br /> * array('WEB.EC.VALID.COUNTRIES') is the parameters to include in the<br /> * function call.<br /> */<br /> $countries = $cache->getCall('Webwizard::call_secure',<br /> array('WEB.EC.VALID.COUNTRIES'));<br /> // this is the original un-cached call (for reference)<br /> //$countries = Webwizard::call_secure('WEB.EC.VALID.COUNTRIES');<br /> return $countries;<br />}<br /><br /><br /><br />/**<br /> * File Contains class CacheWrapper<br /> * @package licensing<br /> * @subpackage utils<br /> * @filesource<br /> */<br /> /**<br /> * Class CacheWrapper<br /> * Puts a wrapper around CacheLite to reduce direct coupling and give<br /> * a uniform interface to Cache_Lite and Cache_Lite_Function<br /> *<br /> * Usage example<br /> * $cacheWrapper = new CacheWrapper(60*60*24);<br /> * $countries = $cacheWrapper->getCall('Webwizard::call_secure', array('WEB.EC.VALID.COUNTRIES'));<br /> *<br /> * @package licensing<br /> * @subpackage utils<br /> */<br />class CacheWrapper {<br /> private $cacheOptions;<br /> private static $dataCacheEngine;<br /> private static $callCacheEngine;<br /> const PEAR_DIRECTORY = "/usr/lib/php";<br /> const DEFAULT_CACHE_TTL = 3600;<br /> const DEFAULT_CACHE_FILE_DIR = "/tmp/";<br /> const DATA = 'dataCacheEngine';<br /> const CALL = 'callCacheEngine';<br /> /**<br /> * Intantiate a CacheWrapper with a TTL and cache file save to dir<br /> *<br /> * @param int $lifetime The cache TTL<br /> * @param string $cacheDir Dir to save the cache files to<br /> */<br /> public function __construct($lifetime=self::DEFAULT_CACHE_TTL, $cacheDir = self::DEFAULT_CACHE_FILE_DIR) {<br /> if ( ! class_exists('Cache_Lite') ) {<br /> ini_set( 'include_path',self::PEAR_DIRECTORY.':'.ini_get('include_path') );<br /> }<br /> self::$dataCacheEngine = null;<br /> self::$callCacheEngine = null;<br /> $this->cacheOptions = array (<br /> 'cacheDir' => $cacheDir,<br /> 'lifeTime' => $lifetime<br /> );<br /> }<br /> /**<br /> * Instantiates the appropriate CacheLite object.<br /> * Only initializes the engine if it does not already exist.<br /> * Note this is a private method<br /> * - Cache_Lite<br /> * - Cache_Lite_Function<br /> *<br /> * @param string $engineType<br /> */<br /> private function initCacheEngine($engineType=self::DATA) {<br /> if ($engineType==self::DATA && ( ! self::$dataCacheEngine) ) {<br /> require_once('Cache/Lite.php');<br /> self::$dataCacheEngine = new Cache_Lite($this->cacheOptions);<br /> } else if (! self::$callCacheEngine) {<br /> require_once('Cache/Lite/Function.php');<br /> self::$callCacheEngine = new Cache_Lite_Function($this->cacheOptions);<br /> }<br /> }<br /> /**<br /> * cache the return value of a function call<br /> *<br /> * @param string $functionName The name of the function to call<br /> * - Examples<br /> * -- Static Method of class [no params]<br /> * <code><br /> * $cacheWrapper = new CacheWrapper();<br /> * return $cacheWrapper->call('WebWizAccessor::getCountries');<br /> * </code><br /> * -- Static Method of class [w/ params]<br /> * <code><br /> * return $cacheWrapper->call('WebWizAccessor::getCountries',array(1,'hello'));<br /> * </code><br /> * @param array $arguments Array of the arguments for the function<br /> * call<br /> */<br /> public function getCall($functionName, $arguments = array()) {<br /> $this->initCacheEngine(self::CALL);<br /> $functionName = $this->formatForFunctionCall($functionName, $arguments);<br /> return call_user_func_array( array(&self::$callCacheEngine,'call'),$arguments );<br /> }<br /> // Output buffer functions //<br /> /**<br /> * Get cached data<br /> *<br /> * A call to attempt to get previously cached data.<br /> * If the cache file does not exist or the ttl has<br /> * expired false is returned. Else the cached content<br /> * is returned. Currently implementing PEAR Cache_Lite for the caching engine.<br /> *<br /> * @param string $cacheId Unique id used internally to track<br /> * the cache file.<br /> * @return string The cached data (FALSE if not found)<br /> */<br /> public function getData($cacheId) {<br /> $this->initCacheEngine(self::DATA);<br /> return self::$dataCacheEngine->get($cacheId);<br /> }<br /> /**<br /> * Save data to cache.<br /> *<br /> * Uses the cache engine to persist the data.<br /> *<br /> * @param mixed $data Data to cache<br /> * @return boolean success of operation.<br /> */<br /> public function saveData($data) {<br /> $this->initCacheEngine(self::DATA);<br /> return self::$dataCacheEngine->save($data);<br /> }<br /> /**<br /> * Start output buffer caching<br /> *<br /> * to be implemented<br /> *<br /> */<br /> public function startData() {die('To be developed');}<br /> /**<br /> * End output buffer caching<br /> *<br /> * To be Implemented<br /> *<br /> */<br /> public function endData() {die('To be developed');}<br /> /**<br /> * Clear the all cache files from disk or if Group is given,<br /> * all those within that group<br /> *<br /> * @param string $group The group to clear<br /> * files for. Files not in group are left untouched. Only relates<br /> * to output buffer cache.<br /> */<br /> public function clearCache($group=null) {<br /> $this->initCacheEngine(self::DATA);<br /> self::$dataCacheEngine->clean($group);<br /> }<br /> public function removeData() {<br /> die("To be implemented");<br /> }<br /> /**<br /> * remove previously cached function/method call<br /> *<br /> * Forcefully removes a previously cached method/function call<br /> *<br /> * @param string $functionName The string name of the function to be removed.<br /> * [leave off ()'s]<br /> * @return void<br /> */<br /> public function removeCall($functionName, $arguments = array()) {<br /> $functionName = $this->formatForFunctionCall($functionName, $arguments);<br /> $this->initCacheEngine(self::CALL);<br /> $cacheId = ( ! self::$callCacheEngine->_fileNameProtection)<br /> ? md5(serialize($arguments))<br /> : serialize($arguments);<br /> self::$callCacheEngine->remove($cacheId, self::$callCacheEngine->_defaultGroup);<br /> }<br /> /**<br /> * Remove all the method/function call files from the cache<br /> *<br /> * @return void<br /> */<br /> public function removeAllCalls() {<br /> $this->initCacheEngine(self::CALL);<br /> self::$callCacheEngine->clean(self::$callCacheEngine->_defaultGroup);<br /> }<br /> /**<br /> * helper function to format calls to cache_lite call.<br /> * If this is a static class call 'MyClass::function', xform it to<br /> * array('MyClass','function') as expected by cache_lite_function->call<br /> */<br /> private function formatForFunctionCall($functionName, &$arguments) {<br /> $functionName = strstr($functionName,'::') ? explode('::',$functionName) : $functionName;<br /> array_unshift($arguments,$functionName);<br /> return $functionName;<br /> }<br />}<br />