2007-04-30 06:01:54 +00:00
|
|
|
<?php
|
|
|
|
/* SVN FILE: $Id$ */
|
|
|
|
/**
|
|
|
|
* Database Storage engine for cache
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* PHP versions 4 and 5
|
|
|
|
*
|
|
|
|
* CakePHP(tm) : Rapid Development Framework <http://www.cakephp.org/>
|
|
|
|
* Copyright 2005-2007, Cake Software Foundation, Inc.
|
|
|
|
* 1785 E. Sahara Avenue, Suite 490-204
|
|
|
|
* Las Vegas, Nevada 89104
|
|
|
|
*
|
|
|
|
* Licensed under The MIT License
|
|
|
|
* Redistributions of files must retain the above copyright notice.
|
|
|
|
*
|
|
|
|
* @filesource
|
|
|
|
* @copyright Copyright 2005-2007, Cake Software Foundation, Inc.
|
|
|
|
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project
|
|
|
|
* @package cake
|
|
|
|
* @subpackage cake.cake.libs.cache
|
|
|
|
* @since CakePHP(tm) v 1.2.0.4933
|
|
|
|
* @version $Revision$
|
|
|
|
* @modifiedby $LastChangedBy$
|
|
|
|
* @lastmodified $Date$
|
|
|
|
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
|
|
|
|
*/
|
|
|
|
/**
|
|
|
|
* Database Storage engine for cache
|
|
|
|
*
|
|
|
|
* @package cake
|
|
|
|
* @subpackage cake.cake.libs.cache
|
|
|
|
*/
|
|
|
|
class ModelEngine extends CacheEngine {
|
2007-05-20 05:35:13 +00:00
|
|
|
/**
|
|
|
|
* Model instance.
|
|
|
|
*
|
|
|
|
* @var object
|
|
|
|
* @access private
|
|
|
|
*/
|
2007-09-30 07:45:34 +00:00
|
|
|
var $__Model = null;
|
2007-05-20 05:35:13 +00:00
|
|
|
/**
|
2007-09-30 07:45:34 +00:00
|
|
|
* settings
|
|
|
|
* className = name of the model to use, default => Cache
|
|
|
|
* fields = database fields that hold data and ttl, default => data, expires
|
2007-05-20 05:35:13 +00:00
|
|
|
*
|
2007-09-30 07:45:34 +00:00
|
|
|
* @var array
|
|
|
|
* @access public
|
2007-05-20 05:35:13 +00:00
|
|
|
*/
|
2007-09-30 07:45:34 +00:00
|
|
|
var $settings = array();
|
2007-05-20 05:35:13 +00:00
|
|
|
/**
|
2007-09-30 07:45:34 +00:00
|
|
|
* Initialize the Cache Engine
|
2007-04-30 06:01:54 +00:00
|
|
|
*
|
|
|
|
* Called automatically by the cache frontend
|
2007-09-30 07:45:34 +00:00
|
|
|
* To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array());
|
2007-04-30 06:01:54 +00:00
|
|
|
*
|
2007-09-30 07:45:34 +00:00
|
|
|
* @param array $setting array of setting for the engine
|
|
|
|
* @return boolean True if the engine has been successfully initialized, false if not
|
2007-04-30 06:01:54 +00:00
|
|
|
* @return boolean True if the engine has been succesfully initialized, false if not
|
|
|
|
*/
|
2007-09-30 07:45:34 +00:00
|
|
|
function init($settings) {
|
|
|
|
parent::init($settings);
|
|
|
|
$defaults = array('className'=> 'Cache', 'fields'=> array('data', 'expires'));
|
|
|
|
$this->settings = am($this->settings, $defaults, $settings);
|
|
|
|
if (!class_exists($this->settings['className']) && !loadModel($this->settings['className'])) {
|
|
|
|
$this->__Model = new $modelName();
|
|
|
|
} else {
|
|
|
|
$this->__Model = new Model(array('name' => $this->settings['className']));
|
2007-04-30 06:01:54 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
|
|
* Garbage collection
|
|
|
|
*
|
|
|
|
* Permanently remove all expired and deleted data
|
2007-05-20 05:35:13 +00:00
|
|
|
*
|
|
|
|
* @access public
|
2007-04-30 06:01:54 +00:00
|
|
|
*/
|
|
|
|
function gc() {
|
2007-09-30 07:45:34 +00:00
|
|
|
return $this->__Model->deleteAll(array($this->__fields[1] => '<= '.time()));
|
2007-04-30 06:01:54 +00:00
|
|
|
}
|
|
|
|
/**
|
2007-09-30 07:45:34 +00:00
|
|
|
* Write data for key into cache
|
2007-04-30 06:01:54 +00:00
|
|
|
*
|
|
|
|
* @param string $key Identifier for the data
|
2007-09-30 07:45:34 +00:00
|
|
|
* @param mixed $data Data to be cached
|
2007-04-30 06:01:54 +00:00
|
|
|
* @param mixed $duration How long to cache the data, in seconds
|
|
|
|
* @return boolean True if the data was succesfully cached, false on failure
|
2007-05-20 05:35:13 +00:00
|
|
|
* @access public
|
2007-04-30 06:01:54 +00:00
|
|
|
*/
|
2007-09-30 07:45:34 +00:00
|
|
|
function write($key, &$data, $duration) {
|
|
|
|
if (isset($this->settings['serialize'])) {
|
|
|
|
$data = serialize($data);
|
|
|
|
}
|
2007-04-30 06:01:54 +00:00
|
|
|
|
2007-09-30 07:45:34 +00:00
|
|
|
if (!$data) {
|
2007-04-30 06:01:54 +00:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2007-09-30 07:45:34 +00:00
|
|
|
$cache = array($this->__Model->name => array(
|
|
|
|
$this->__fields[0] => $data,
|
|
|
|
$this->__fields[1] => time() + $duration));
|
|
|
|
|
|
|
|
$oldId = $this->__Model->id;
|
|
|
|
$this->__Model->id = $key;
|
|
|
|
$res = $this->__Model->save($cache);
|
|
|
|
$this->__Model->id = $oldId;
|
2007-04-30 06:01:54 +00:00
|
|
|
return $res;
|
|
|
|
}
|
|
|
|
/**
|
2007-09-30 07:45:34 +00:00
|
|
|
* Read a key from the cache
|
2007-04-30 06:01:54 +00:00
|
|
|
*
|
|
|
|
* @param string $key Identifier for the data
|
|
|
|
* @return mixed The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it
|
2007-05-20 05:35:13 +00:00
|
|
|
* @access public
|
2007-04-30 06:01:54 +00:00
|
|
|
*/
|
|
|
|
function read($key) {
|
2007-09-30 07:45:34 +00:00
|
|
|
$data = $this->__Model->field($this->__fields[0], array($this->__Model->primaryKey => $key, $this->__fields[1] => '> '.time()));
|
|
|
|
if (!$data) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
if (isset($this->settings['serialize'])) {
|
|
|
|
return unserialize($val);
|
|
|
|
}
|
|
|
|
return $data;
|
2007-04-30 06:01:54 +00:00
|
|
|
}
|
|
|
|
/**
|
2007-09-30 07:45:34 +00:00
|
|
|
* Delete a key from the cache
|
2007-04-30 06:01:54 +00:00
|
|
|
*
|
|
|
|
* @param string $key Identifier for the data
|
|
|
|
* @return boolean True if the value was succesfully deleted, false if it didn't exist or couldn't be removed
|
2007-05-20 05:35:13 +00:00
|
|
|
* @access public
|
2007-04-30 06:01:54 +00:00
|
|
|
*/
|
|
|
|
function delete($key) {
|
2007-09-30 07:45:34 +00:00
|
|
|
return $this->__Model->del($key);
|
2007-04-30 06:01:54 +00:00
|
|
|
}
|
|
|
|
/**
|
2007-09-30 07:45:34 +00:00
|
|
|
* Delete all keys from the cache
|
2007-04-30 06:01:54 +00:00
|
|
|
*
|
|
|
|
* @return boolean True if the cache was succesfully cleared, false otherwise
|
2007-05-20 05:35:13 +00:00
|
|
|
* @access public
|
2007-04-30 06:01:54 +00:00
|
|
|
*/
|
|
|
|
function clear() {
|
2007-09-30 07:45:34 +00:00
|
|
|
return $this->__Model->deleteAll(null);
|
2007-04-30 07:38:47 +00:00
|
|
|
}
|
2007-09-30 07:45:34 +00:00
|
|
|
|
2007-04-30 06:01:54 +00:00
|
|
|
}
|
|
|
|
?>
|