Members/shoshi/webvirt: cake/libs/cache.php annotate

author	Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp>
date	Sun, 24 Jul 2011 21:08:31 +0900
parents
children

rev	line source
0 261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	1 <?php
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	2 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	3 * Caching for CakePHP.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	4 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	5 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	6 * PHP versions 4 and 5
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	7 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	8 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	9 * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	10 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	11 * Licensed under The MIT License
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	12 * Redistributions of files must retain the above copyright notice.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	13 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	14 * @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	15 * @link http://cakephp.org CakePHP(tm) Project
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	16 * @package cake
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	17 * @subpackage cake.cake.libs
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	18 * @since CakePHP(tm) v 1.2.0.4933
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	19 * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	20 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	21
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	22 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	23 * Caching for CakePHP.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	24 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	25 * @package cake
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	26 * @subpackage cake.cake.libs
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	27 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	28 class Cache {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	29
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	30 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	31 * Cache configuration stack
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	32 * Keeps the permanent/default settings for each cache engine.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	33 * These settings are used to reset the engines after temporary modification.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	34 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	35 * @var array
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	36 * @access private
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	37 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	38 var $__config = array();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	39
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	40 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	41 * Holds name of the current configuration name being used.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	42 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	43 * @var array
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	44 * @access private
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	45 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	46 var $__name = 'default';
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	47
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	48 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	49 * Whether to reset the settings with the next call to Cache::set();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	50 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	51 * @var array
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	52 * @access private
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	53 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	54 var $__reset = false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	55
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	56 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	57 * Engine instances keyed by configuration name.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	58 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	59 * @var array
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	60 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	61 var $_engines = array();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	62
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	63 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	64 * Returns a singleton instance
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	65 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	66 * @return object
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	67 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	68 * @static
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	69 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	70 function &getInstance() {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	71 static $instance = array();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	72 if (!$instance) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	73 $instance[0] =& new Cache();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	74 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	75 return $instance[0];
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	76 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	77
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	78 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	79 * Set the cache configuration to use. config() can
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	80 * both create new configurations, return the settings for already configured
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	81 * configurations. It also sets the 'default' configuration to use for subsequent
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	82 * operations.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	83 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	84 * To create a new configuration:
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	85 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	86 * `Cache::config('my_config', array('engine' => 'File', 'path' => TMP));`
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	87 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	88 * To get the settings for a configuration, and set it as the currently selected configuration
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	89 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	90 * `Cache::config('default');`
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	91 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	92 * The following keys are used in core cache engines:
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	93 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	94 * - `duration` Specify how long items in this cache configuration last.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	95 * - `prefix` Prefix appended to all entries. Good for when you need to share a keyspace
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	96 * with either another cache config or annother application.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	97 * - `probability` Probability of hitting a cache gc cleanup. Setting to 0 will disable
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	98 * cache::gc from ever being called automatically.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	99 * - `servers' Used by memcache. Give the address of the memcached servers to use.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	100 * - `compress` Used by memcache. Enables memcache's compressed format.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	101 * - `serialize` Used by FileCache. Should cache objects be serialized first.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	102 * - `path` Used by FileCache. Path to where cachefiles should be saved.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	103 * - `lock` Used by FileCache. Should files be locked before writing to them?
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	104 * - `user` Used by Xcache. Username for XCache
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	105 * - `password` Used by Xcache. Password for XCache
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	106 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	107 * @see app/config/core.php for configuration settings
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	108 * @param string $name Name of the configuration
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	109 * @param array $settings Optional associative array of settings passed to the engine
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	110 * @return array(engine, settings) on success, false on failure
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	111 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	112 * @static
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	113 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	114 function config($name = null, $settings = array()) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	115 $self =& Cache::getInstance();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	116 if (is_array($name)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	117 $settings = $name;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	118 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	119
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	120 if ($name === null \|\| !is_string($name)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	121 $name = $self->__name;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	122 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	123
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	124 $current = array();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	125 if (isset($self->__config[$name])) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	126 $current = $self->__config[$name];
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	127 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	128
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	129 if (!empty($settings)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	130 $self->__config[$name] = array_merge($current, $settings);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	131 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	132
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	133 if (empty($self->__config[$name]['engine'])) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	134 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	135 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	136
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	137 $engine = $self->__config[$name]['engine'];
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	138 $self->__name = $name;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	139
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	140 if (!isset($self->_engines[$name])) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	141 $self->_buildEngine($name);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	142 $settings = $self->__config[$name] = $self->settings($name);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	143 } elseif ($settings = $self->set($self->__config[$name])) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	144 $self->__config[$name] = $settings;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	145 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	146 return compact('engine', 'settings');
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	147 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	148
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	149 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	150 * Finds and builds the instance of the required engine class.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	151 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	152 * @param string $name Name of the config array that needs an engine instance built
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	153 * @return void
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	154 * @access protected
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	155 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	156 function _buildEngine($name) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	157 $config = $this->__config[$name];
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	158
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	159 list($plugin, $class) = pluginSplit($config['engine']);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	160 $cacheClass = $class . 'Engine';
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	161 if (!class_exists($cacheClass) && $this->__loadEngine($class, $plugin) === false) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	162 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	163 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	164 $cacheClass = $class . 'Engine';
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	165 $this->_engines[$name] =& new $cacheClass();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	166 if ($this->_engines[$name]->init($config)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	167 if ($this->_engines[$name]->settings['probability'] && time() % $this->_engines[$name]->settings['probability'] === 0) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	168 $this->_engines[$name]->gc();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	169 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	170 return true;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	171 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	172 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	173 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	174
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	175 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	176 * Returns an array containing the currently configured Cache settings.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	177 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	178 * @return array Array of configured Cache config names.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	179 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	180 function configured() {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	181 $self =& Cache::getInstance();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	182 return array_keys($self->__config);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	183 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	184
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	185 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	186 * Drops a cache engine. Deletes the cache configuration information
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	187 * If the deleted configuration is the last configuration using an certain engine,
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	188 * the Engine instance is also unset.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	189 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	190 * @param string $name A currently configured cache config you wish to remove.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	191 * @return boolen success of the removal, returns false when the config does not exist.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	192 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	193 function drop($name) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	194 $self =& Cache::getInstance();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	195 if (!isset($self->__config[$name])) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	196 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	197 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	198 unset($self->__config[$name]);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	199 unset($self->_engines[$name]);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	200 return true;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	201 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	202
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	203 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	204 * Tries to find and include a file for a cache engine and returns object instance
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	205 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	206 * @param $name Name of the engine (without 'Engine')
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	207 * @return mixed $engine object or null
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	208 * @access private
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	209 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	210 function __loadEngine($name, $plugin = null) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	211 if ($plugin) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	212 return App::import('Lib', $plugin . '.cache' . DS . $name, false);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	213 } else {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	214 $core = App::core();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	215 $path = $core['libs'][0] . 'cache' . DS . strtolower($name) . '.php';
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	216 if (file_exists($path)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	217 require $path;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	218 return true;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	219 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	220 return App::import('Lib', 'cache' . DS . $name, false);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	221 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	222 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	223
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	224 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	225 * Temporarily change settings to current config options. if no params are passed, resets settings if needed
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	226 * Cache::write() will reset the configuration changes made
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	227 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	228 * @param mixed $settings Optional string for simple name-value pair or array
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	229 * @param string $value Optional for a simple name-value pair
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	230 * @return array Array of settings.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	231 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	232 * @static
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	233 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	234 function set($settings = array(), $value = null) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	235 $self =& Cache::getInstance();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	236 if (!isset($self->__config[$self->__name]) \|\| !isset($self->_engines[$self->__name])) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	237 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	238 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	239 $name = $self->__name;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	240 if (!empty($settings)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	241 $self->__reset = true;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	242 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	243
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	244 if ($self->__reset === true) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	245 if (empty($settings)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	246 $self->__reset = false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	247 $settings = $self->__config[$name];
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	248 } else {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	249 if (is_string($settings) && $value !== null) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	250 $settings = array($settings => $value);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	251 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	252 $settings = array_merge($self->__config[$name], $settings);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	253 if (isset($settings['duration']) && !is_numeric($settings['duration'])) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	254 $settings['duration'] = strtotime($settings['duration']) - time();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	255 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	256 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	257 $self->_engines[$name]->settings = $settings;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	258 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	259 return $self->settings($name);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	260 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	261
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	262 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	263 * Garbage collection
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	264 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	265 * Permanently remove all expired and deleted data
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	266 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	267 * @return void
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	268 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	269 * @static
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	270 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	271 function gc() {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	272 $self =& Cache::getInstance();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	273 $self->_engines[$self->__name]->gc();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	274 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	275
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	276 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	277 * Write data for key into cache. Will automatically use the currently
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	278 * active cache configuration. To set the currently active configuration use
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	279 * Cache::config()
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	280 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	281 * ### Usage:
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	282 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	283 * Writing to the active cache config:
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	284 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	285 * `Cache::write('cached_data', $data);`
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	286 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	287 * Writing to a specific cache config:
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	288 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	289 * `Cache::write('cached_data', $data, 'long_term');`
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	290 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	291 * @param string $key Identifier for the data
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	292 * @param mixed $value Data to be cached - anything except a resource
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	293 * @param string $config Optional string configuration name to write to.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	294 * @return boolean True if the data was successfully cached, false on failure
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	295 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	296 * @static
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	297 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	298 function write($key, $value, $config = null) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	299 $self =& Cache::getInstance();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	300
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	301 if (!$config) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	302 $config = $self->__name;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	303 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	304 $settings = $self->settings($config);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	305
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	306 if (empty($settings)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	307 return null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	308 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	309 if (!$self->isInitialized($config)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	310 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	311 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	312 $key = $self->_engines[$config]->key($key);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	313
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	314 if (!$key \|\| is_resource($value)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	315 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	316 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	317
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	318 $success = $self->_engines[$config]->write($settings['prefix'] . $key, $value, $settings['duration']);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	319 $self->set();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	320 return $success;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	321 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	322
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	323 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	324 * Read a key from the cache. Will automatically use the currently
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	325 * active cache configuration. To set the currently active configuration use
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	326 * Cache::config()
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	327 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	328 * ### Usage:
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	329 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	330 * Reading from the active cache configuration.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	331 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	332 * `Cache::read('my_data');`
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	333 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	334 * Reading from a specific cache configuration.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	335 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	336 * `Cache::read('my_data', 'long_term');`
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	337 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	338 * @param string $key Identifier for the data
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	339 * @param string $config optional name of the configuration to use.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	340 * @return mixed The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	341 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	342 * @static
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	343 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	344 function read($key, $config = null) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	345 $self =& Cache::getInstance();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	346
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	347 if (!$config) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	348 $config = $self->__name;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	349 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	350 $settings = $self->settings($config);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	351
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	352 if (empty($settings)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	353 return null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	354 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	355 if (!$self->isInitialized($config)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	356 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	357 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	358 $key = $self->_engines[$config]->key($key);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	359 if (!$key) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	360 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	361 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	362 $success = $self->_engines[$config]->read($settings['prefix'] . $key);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	363
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	364 if ($config !== null && $config !== $self->__name) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	365 $self->set();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	366 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	367 return $success;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	368 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	369
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	370 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	371 * Increment a number under the key and return incremented value.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	372 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	373 * @param string $key Identifier for the data
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	374 * @param integer $offset How much to add
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	375 * @param string $config Optional string configuration name. If not specified the current
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	376 * default config will be used.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	377 * @return mixed new value, or false if the data doesn't exist, is not integer,
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	378 * or if there was an error fetching it.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	379 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	380 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	381 function increment($key, $offset = 1, $config = null) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	382 $self =& Cache::getInstance();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	383
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	384 if (!$config) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	385 $config = $self->__name;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	386 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	387 $settings = $self->settings($config);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	388
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	389 if (empty($settings)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	390 return null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	391 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	392 if (!$self->isInitialized($config)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	393 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	394 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	395 $key = $self->_engines[$config]->key($key);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	396
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	397 if (!$key \|\| !is_integer($offset) \|\| $offset < 0) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	398 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	399 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	400 $success = $self->_engines[$config]->increment($settings['prefix'] . $key, $offset);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	401 $self->set();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	402 return $success;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	403 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	404 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	405 * Decrement a number under the key and return decremented value.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	406 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	407 * @param string $key Identifier for the data
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	408 * @param integer $offset How much to substract
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	409 * @param string $config Optional string configuration name, if not specified the current
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	410 * default config will be used.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	411 * @return mixed new value, or false if the data doesn't exist, is not integer,
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	412 * or if there was an error fetching it
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	413 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	414 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	415 function decrement($key, $offset = 1, $config = null) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	416 $self =& Cache::getInstance();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	417
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	418 if (!$config) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	419 $config = $self->__name;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	420 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	421 $settings = $self->settings($config);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	422
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	423 if (empty($settings)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	424 return null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	425 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	426 if (!$self->isInitialized($config)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	427 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	428 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	429 $key = $self->_engines[$config]->key($key);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	430
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	431 if (!$key \|\| !is_integer($offset) \|\| $offset < 0) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	432 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	433 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	434 $success = $self->_engines[$config]->decrement($settings['prefix'] . $key, $offset);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	435 $self->set();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	436 return $success;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	437 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	438 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	439 * Delete a key from the cache. Will automatically use the currently
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	440 * active cache configuration. To set the currently active configuration use
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	441 * Cache::config()
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	442 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	443 * ### Usage:
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	444 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	445 * Deleting from the active cache configuration.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	446 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	447 * `Cache::delete('my_data');`
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	448 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	449 * Deleting from a specific cache configuration.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	450 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	451 * `Cache::delete('my_data', 'long_term');`
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	452 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	453 * @param string $key Identifier for the data
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	454 * @param string $config name of the configuration to use
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	455 * @return boolean True if the value was succesfully deleted, false if it didn't exist or couldn't be removed
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	456 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	457 * @static
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	458 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	459 function delete($key, $config = null) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	460 $self =& Cache::getInstance();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	461 if (!$config) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	462 $config = $self->__name;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	463 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	464 $settings = $self->settings($config);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	465
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	466 if (empty($settings)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	467 return null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	468 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	469 if (!$self->isInitialized($config)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	470 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	471 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	472 $key = $self->_engines[$config]->key($key);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	473 if (!$key) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	474 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	475 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	476
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	477 $success = $self->_engines[$config]->delete($settings['prefix'] . $key);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	478 $self->set();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	479 return $success;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	480 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	481
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	482 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	483 * Delete all keys from the cache.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	484 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	485 * @param boolean $check if true will check expiration, otherwise delete all
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	486 * @param string $config name of the configuration to use
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	487 * @return boolean True if the cache was succesfully cleared, false otherwise
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	488 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	489 * @static
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	490 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	491 function clear($check = false, $config = null) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	492 $self =& Cache::getInstance();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	493 if (!$config) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	494 $config = $self->__name;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	495 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	496 $settings = $self->settings($config);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	497
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	498 if (empty($settings)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	499 return null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	500 }

0

261e66bd5a0c hg init