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/>
|
2008-01-01 22:18:17 +00:00
|
|
|
* Copyright 2005-2008, Cake Software Foundation, Inc.
|
2007-04-30 06:01:54 +00:00
|
|
|
* 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
|
2008-01-01 22:18:17 +00:00
|
|
|
* @copyright Copyright 2005-2008, Cake Software Foundation, Inc.
|
2007-04-30 06:01:54 +00:00
|
|
|
* @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-11-09 08:00:59 +00:00
|
|
|
/**
|
|
|
|
* settings
|
|
|
|
* className = name of the model to use, default => Cache
|
|
|
|
* fields = database fields that hold data and ttl, default => data, expires
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
* @access public
|
|
|
|
*/
|
|
|
|
var $settings = array();
|
|
|
|
|
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-11-09 08:00:59 +00:00
|
|
|
* Model instance.
|
2007-05-20 05:35:13 +00:00
|
|
|
*
|
2007-11-09 08:00:59 +00:00
|
|
|
* @var object
|
|
|
|
* @access private
|
2007-05-20 05:35:13 +00:00
|
|
|
*/
|
2007-11-09 08:00:59 +00:00
|
|
|
var $__fields = 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
|
2007-10-22 16:09:35 +00:00
|
|
|
* @return boolean True if the engine has been successfully initialized, false if not
|
2007-10-22 06:23:57 +00:00
|
|
|
* @access public
|
2007-04-30 06:01:54 +00:00
|
|
|
*/
|
2007-09-30 07:45:34 +00:00
|
|
|
function init($settings) {
|
|
|
|
parent::init($settings);
|
2007-11-09 08:00:59 +00:00
|
|
|
$defaults = array('className'=> 'CacheModel', 'fields'=> array('data', 'expires'));
|
2007-12-08 06:08:03 +00:00
|
|
|
$this->settings = array_merge($this->settings, $defaults, $settings);
|
2007-11-09 08:00:59 +00:00
|
|
|
$className = $this->settings['className'];
|
|
|
|
$this->__fields = $this->settings['fields'];
|
Closes #2119 Only define clone() in PHP4 when it hasn't been already defined.
Closes #2213, Support multiple plugin paths.
Closes #2234, filepaths to behavior classes should be cached in class.paths.php also
Closes #2345, ability to group components into subfolders
Closes #2645, Improvement to basic.php for class loading.
Fixes #3526, Cache::write, when using just the config name, it fails.
Fixes #3559, loading plugin model as assoc don't work.
Closes #3567 Controller Folders (Note this does not need routing to work, but controller names can not conflict with others in the same application so naming must still be unique)
Fixes #3579, email.php component: Parse error with php 4.
Adding new class and file importer.
Updated most of the core to use the importer.
Added ClassRegsitry::init() that will create and instance of an object and store it in the registry.
Deprecated most of the load functions in basics.php
Plugin model loading now forces using the dot notation, to use models within a plugin, all the model associations must be in the PluginName.Model syntax, if this is not used, the plugin will look for the models in the main app/models directory first, if not found then it will search the plugin directories recursively until it finds a model.
var $belongsTo = array('SomeModel'); will look for some_model.php in the app/models
var $belongsTo = array('MyPlugin.SomeModel'); will look for some_model.php in my_plugin/models
var $belongsTo = array('MyPlugin.MyPlugin', 'SomeModel'); will used my_plugin/models/my_plugin.php and app/models/some_model.php
The controllers of the plugin will still look for the default models inside the plugin if var $uses is not set:
var $uses = array('SomeModel'); will look for some_model.php in the app/models
var $uses = array('MyPlugin.SomeModel'); will look for some_model.php in my_plugin/models
var $uses = array('MyPlugin.MyPlugin', 'SomeModel'); will used my_plugin/models/my_plugin.php and app/models/some_model.php
All of the above will work between plugins and main app
These changes also allow placing model and controllers is sub directories
Removed old class.paths.php file generation
git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@6001 3807eeeb-6ff5-0310-8944-8be069107fe0
2007-11-16 09:35:19 +00:00
|
|
|
if (App::import($className)) {
|
|
|
|
$this->__Model = ClassRegistry::init($className);
|
2007-09-30 07:45:34 +00:00
|
|
|
} else {
|
2007-11-09 08:00:59 +00:00
|
|
|
$this->__Model = new Model(array('name' => $className));
|
2007-04-30 06:01:54 +00:00
|
|
|
}
|
2007-11-09 08:00:59 +00:00
|
|
|
return true;
|
2007-04-30 06:01:54 +00:00
|
|
|
}
|
|
|
|
/**
|
2007-10-22 06:23:57 +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-10-22 16:11:12 +00:00
|
|
|
* @param integer $duration How long to cache the data, in seconds
|
2007-10-22 16:09:35 +00:00
|
|
|
* @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);
|
|
|
|
}
|
2008-03-10 06:05:31 +00:00
|
|
|
if ($data === '') {
|
2007-04-30 06:01:54 +00:00
|
|
|
return false;
|
|
|
|
}
|
2008-03-10 06:05:31 +00:00
|
|
|
$cache = array('id' => $key, $this->__fields[0] => $data, $this->__fields[1] => time() + $duration);
|
2007-11-09 08:00:59 +00:00
|
|
|
$result = false;
|
2008-03-10 06:05:31 +00:00
|
|
|
|
2007-11-09 08:00:59 +00:00
|
|
|
if ($this->__Model->save($cache)) {
|
|
|
|
$result = true;
|
|
|
|
}
|
|
|
|
return $result;
|
2007-04-30 06:01:54 +00:00
|
|
|
}
|
|
|
|
/**
|
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'])) {
|
2007-11-09 08:00:59 +00:00
|
|
|
return unserialize($data);
|
2007-09-30 07:45:34 +00:00
|
|
|
}
|
|
|
|
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
|
2007-10-22 16:09:35 +00:00
|
|
|
* @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
|
|
|
*
|
2007-10-22 16:09:35 +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-12-23 07:56:36 +00:00
|
|
|
return $this->__Model->deleteAll('1=1');
|
2007-04-30 07:38:47 +00:00
|
|
|
}
|
2007-09-30 07:45:34 +00:00
|
|
|
|
2007-04-30 06:01:54 +00:00
|
|
|
}
|
|
|
|
?>
|