Cache.php 17.9 KB
Newer Older
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
8 9
namespace yii\caching;

10
use Yii;
11
use yii\base\Component;
Qiang Xue committed
12
use yii\helpers\StringHelper;
Qiang Xue committed
13

Qiang Xue committed
14
/**
Qiang Xue committed
15
 * Cache is the base class for cache classes supporting different cache storage implementation.
Qiang Xue committed
16
 *
Qiang Xue committed
17 18
 * A data item can be stored in cache by calling [[set()]] and be retrieved back
 * later (in the same or different request) by [[get()]]. In both operations,
Qiang Xue committed
19
 * a key identifying the data item is required. An expiration time and/or a [[Dependency|dependency]]
Qiang Xue committed
20 21
 * can also be specified when calling [[set()]]. If the data item expires or the dependency
 * changes at the time of calling [[get()]], the cache will return no data.
Qiang Xue committed
22
 *
23
 * A typical usage pattern of cache is like the following:
Qiang Xue committed
24
 *
25 26 27 28 29 30 31 32
 * ~~~
 * $key = 'demo';
 * $data = $cache->get($key);
 * if ($data === false) {
 *     // ...generate $data here...
 *     $cache->set($key, $data, $expire, $dependency);
 * }
 * ~~~
Qiang Xue committed
33
 *
Qiang Xue committed
34
 * Because Cache implements the ArrayAccess interface, it can be used like an array. For example,
Qiang Xue committed
35
 *
Qiang Xue committed
36 37 38 39
 * ~~~
 * $cache['foo'] = 'some data';
 * echo $cache['foo'];
 * ~~~
Qiang Xue committed
40
 *
41 42 43 44 45 46 47 48
 * Derived classes should implement the following methods:
 *
 * - [[getValue()]]: retrieve the value with a key (if any) from cache
 * - [[setValue()]]: store the value with a key into cache
 * - [[addValue()]]: store the value only if the cache does not have this key before
 * - [[deleteValue()]]: delete the value with the specified key from cache
 * - [[flushValues()]]: delete all values from cache
 *
Qiang Xue committed
49
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
50
 * @since 2.0
Qiang Xue committed
51
 */
52
abstract class Cache extends Component implements \ArrayAccess
Qiang Xue committed
53 54
{
	/**
55
	 * @var string a string prefixed to every cache key so that it is unique. If not set,
56
	 * it will use a prefix generated from [[\yii\base\Application::id]]. You may set this property to be an empty string
Qiang Xue committed
57 58
	 * if you don't want to use key prefix. It is recommended that you explicitly set this property to some
	 * static value if the cached data needs to be shared among multiple applications.
59
	 *
Carsten Brandt committed
60
	 * To ensure interoperability, only alphanumeric characters should be used.
Qiang Xue committed
61 62 63
	 */
	public $keyPrefix;
	/**
Qiang Xue committed
64 65 66 67 68 69
	 * @var array|boolean the functions used to serialize and unserialize cached data. Defaults to null, meaning
	 * using the default PHP `serialize()` and `unserialize()` functions. If you want to use some more efficient
	 * serializer (e.g. [igbinary](http://pecl.php.net/package/igbinary)), you may configure this property with
	 * a two-element array. The first element specifies the serialization function, and the second the deserialization
	 * function. If this property is set false, data will be directly sent to and retrieved from the underlying
	 * cache component without any serialization or deserialization. You should not turn off serialization if
Qiang Xue committed
70
	 * you are using [[Dependency|cache dependency]], because it relies on data serialization.
Qiang Xue committed
71
	 */
Qiang Xue committed
72
	public $serializer;
Qiang Xue committed
73

Qiang Xue committed
74

75 76 77 78 79 80 81 82
	/**
	 * Initializes the application component.
	 * This method overrides the parent implementation by setting default cache key prefix.
	 */
	public function init()
	{
		parent::init();
		if ($this->keyPrefix === null) {
83
			$this->keyPrefix = substr(md5(Yii::$app->id), 0, 5);
84 85 86
		}
	}

Qiang Xue committed
87
	/**
Qiang Xue committed
88
	 * Builds a normalized cache key from a given key.
89
	 *
Qiang Xue committed
90
	 * If the given key is a string containing alphanumeric characters only and no more than 32 characters,
91 92
	 * then the key will be returned back prefixed with [[keyPrefix]]. Otherwise, a normalized key
	 * is generated by serializing the given key, applying MD5 hashing, and prefixing with [[keyPrefix]].
93
	 *
94 95
	 * @param mixed $key the key to be normalized
	 * @return string the generated cache key
Qiang Xue committed
96
	 */
97
	protected function buildKey($key)
Qiang Xue committed
98
	{
Qiang Xue committed
99
		if (is_string($key)) {
100
			$key = ctype_alnum($key) && StringHelper::byteLength($key) <= 32 ? $key : md5($key);
Qiang Xue committed
101
		} else {
votintsev committed
102
			$key = md5(json_encode($key));
Qiang Xue committed
103
		}
votintsev committed
104
		return $this->keyPrefix . $key;
Qiang Xue committed
105 106
	}

Qiang Xue committed
107 108
	/**
	 * Retrieves a value from cache with a specified key.
109 110
	 * @param mixed $key a key identifying the cached value. This can be a simple string or
	 * a complex data structure consisting of factors representing the key.
Qiang Xue committed
111 112
	 * @return mixed the value stored in cache, false if the value is not in the cache, expired,
	 * or the dependency associated with the cached data has changed.
Qiang Xue committed
113
	 */
114
	public function get($key)
Qiang Xue committed
115
	{
votintsev committed
116
		$key = $this->buildKey($key);
117
		$value = $this->getValue($key);
Qiang Xue committed
118 119 120 121 122 123 124
		if ($value === false || $this->serializer === false) {
			return $value;
		} elseif ($this->serializer === null) {
			$value = unserialize($value);
		} else {
			$value = call_user_func($this->serializer[1], $value);
		}
125
		if (is_array($value) && !($value[1] instanceof Dependency && $value[1]->getHasChanged($this))) {
Qiang Xue committed
126 127 128
			return $value[0];
		} else {
			return false;
Qiang Xue committed
129 130 131
		}
	}

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
	/**
	 * Checks whether a specified key exists in the cache.
	 * This can be faster than getting the value from the cache if the data is big.
	 * In case a cache does not support this feature natively, this method will try to simulate it
	 * but has no performance improvement over getting it.
	 * Note that this method does not check whether the dependency associated
	 * with the cached data, if there is any, has changed. So a call to [[get]]
	 * may return false while exists returns true.
	 * @param mixed $key a key identifying the cached value. This can be a simple string or
	 * a complex data structure consisting of factors representing the key.
	 * @return boolean true if a value exists in cache, false if the value is not in the cache or expired.
	 */
	public function exists($key)
	{
		$key = $this->buildKey($key);
		$value = $this->getValue($key);
		return $value !== false;
	}

Qiang Xue committed
151 152
	/**
	 * Retrieves multiple values from cache with the specified keys.
Qiang Xue committed
153 154 155
	 * Some caches (such as memcache, apc) allow retrieving multiple cached values at the same time,
	 * which may improve the performance. In case a cache does not support this feature natively,
	 * this method will try to simulate it.
156
	 * @param array $keys list of keys identifying the cached values
Qiang Xue committed
157
	 * @return array list of cached values corresponding to the specified keys. The array
resurtm committed
158
	 * is returned in terms of (key, value) pairs.
Qiang Xue committed
159 160
	 * If a value is not cached or expired, the corresponding array value will be false.
	 */
161
	public function mget($keys)
Qiang Xue committed
162
	{
Alexander Makarov committed
163
		$keyMap = [];
164
		foreach ($keys as $key) {
votintsev committed
165
			$keyMap[$key] = $this->buildKey($key);
Qiang Xue committed
166
		}
167
		$values = $this->getValues(array_values($keyMap));
Alexander Makarov committed
168
		$results = [];
169 170 171 172 173 174 175
		foreach ($keyMap as $key => $newKey) {
			$results[$key] = false;
			if (isset($values[$newKey])) {
				if ($this->serializer === false) {
					$results[$key] = $values[$newKey];
				} else {
					$value = $this->serializer === null ? unserialize($values[$newKey])
176
						: call_user_func($this->serializer[1], $values[$newKey]);
177

178
					if (is_array($value) && !($value[1] instanceof Dependency && $value[1]->getHasChanged($this))) {
179
						$results[$key] = $value[0];
Qiang Xue committed
180 181
					}
				}
Qiang Xue committed
182 183 184 185 186 187 188 189
			}
		}
		return $results;
	}

	/**
	 * Stores a value identified by a key into cache.
	 * If the cache already contains such a key, the existing value and
Qiang Xue committed
190
	 * expiration time will be replaced with the new ones, respectively.
Qiang Xue committed
191
	 *
Panagiotis Moustafellos committed
192
	 * @param mixed $key a key identifying the value to be cached. This can be a simple string or
193
	 * a complex data structure consisting of factors representing the key.
Qiang Xue committed
194 195
	 * @param mixed $value the value to be cached
	 * @param integer $expire the number of seconds in which the cached value will expire. 0 means never expire.
Qiang Xue committed
196
	 * @param Dependency $dependency dependency of the cached item. If the dependency changes,
Qiang Xue committed
197
	 * the corresponding value in the cache will be invalidated when it is fetched via [[get()]].
198
	 * This parameter is ignored if [[serializer]] is false.
Qiang Xue committed
199
	 * @return boolean whether the value is successfully stored into cache
Qiang Xue committed
200
	 */
201
	public function set($key, $value, $expire = 0, $dependency = null)
Qiang Xue committed
202
	{
Qiang Xue committed
203
		if ($dependency !== null && $this->serializer !== false) {
204
			$dependency->evaluateDependency($this);
Qiang Xue committed
205
		}
Qiang Xue committed
206
		if ($this->serializer === null) {
Alexander Makarov committed
207
			$value = serialize([$value, $dependency]);
Qiang Xue committed
208
		} elseif ($this->serializer !== false) {
Alexander Makarov committed
209
			$value = call_user_func($this->serializer[0], [$value, $dependency]);
Qiang Xue committed
210
		}
votintsev committed
211
		$key = $this->buildKey($key);
212
		return $this->setValue($key, $value, $expire);
Qiang Xue committed
213 214
	}

215 216 217 218 219
	/**
	 * Stores multiple items in cache. Each item contains a value identified by a key.
	 * If the cache already contains such a key, the existing value and
	 * expiration time will be replaced with the new ones, respectively.
	 *
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
	 * @param array $items the items to be cached, as key-value pairs.
	 * @param integer $expire default number of seconds in which the cached values will expire. 0 means never expire.
	 * @param Dependency $dependency dependency of the cached items. If the dependency changes,
	 * the corresponding values in the cache will be invalidated when it is fetched via [[get()]].
	 * This parameter is ignored if [[serializer]] is false.
	 * @return boolean whether the items are successfully stored into cache
	 */
	public function mset($items, $expire = 0, $dependency = null)
	{
		if ($dependency !== null && $this->serializer !== false) {
			$dependency->evaluateDependency($this);
		}

		$data = [];
		foreach ($items as $key => $value) {
			if ($this->serializer === null) {
236
				$value = serialize([$value, $dependency]);
237
			} elseif ($this->serializer !== false) {
238
				$value = call_user_func($this->serializer[0], [$value, $dependency]);
239 240
			}

241 242
			$key = $this->buildKey($key);
			$data[$key] = $value;
243 244 245 246 247 248 249 250 251 252 253 254 255
		}
		return $this->setValues($data, $expire);
	}

	/**
	 * Stores multiple items in cache. Each item contains a value identified by a key.
	 * If the cache already contains such a key, the existing value and expiration time will be preserved.
	 *
	 * @param array $items the items to be cached, as key-value pairs.
	 * @param integer $expire default number of seconds in which the cached values will expire. 0 means never expire.
	 * @param Dependency $dependency dependency of the cached items. If the dependency changes,
	 * the corresponding values in the cache will be invalidated when it is fetched via [[get()]].
	 * This parameter is ignored if [[serializer]] is false.
256 257
	 * @return boolean whether the items are successfully stored into cache
	 */
258
	public function madd($items, $expire = 0, $dependency = null)
259
	{
260 261 262 263 264 265 266
		if ($dependency !== null && $this->serializer !== false) {
			$dependency->evaluateDependency($this);
		}

		$data = [];
		foreach ($items as $key => $value) {
			if ($this->serializer === null) {
267
				$value = serialize([$value, $dependency]);
268
			} elseif ($this->serializer !== false) {
269
				$value = call_user_func($this->serializer[0], [$value, $dependency]);
270 271
			}

272 273
			$key = $this->buildKey($key);
			$data[$key] = $value;
274 275
		}
		return $this->addValues($data, $expire);
276 277
	}

Qiang Xue committed
278 279 280
	/**
	 * Stores a value identified by a key into cache if the cache does not contain this key.
	 * Nothing will be done if the cache already contains the key.
Panagiotis Moustafellos committed
281
	 * @param mixed $key a key identifying the value to be cached. This can be a simple string or
282
	 * a complex data structure consisting of factors representing the key.
Qiang Xue committed
283 284
	 * @param mixed $value the value to be cached
	 * @param integer $expire the number of seconds in which the cached value will expire. 0 means never expire.
Qiang Xue committed
285
	 * @param Dependency $dependency dependency of the cached item. If the dependency changes,
Qiang Xue committed
286
	 * the corresponding value in the cache will be invalidated when it is fetched via [[get()]].
287
	 * This parameter is ignored if [[serializer]] is false.
Qiang Xue committed
288
	 * @return boolean whether the value is successfully stored into cache
Qiang Xue committed
289
	 */
290
	public function add($key, $value, $expire = 0, $dependency = null)
Qiang Xue committed
291
	{
Qiang Xue committed
292
		if ($dependency !== null && $this->serializer !== false) {
293
			$dependency->evaluateDependency($this);
Qiang Xue committed
294
		}
Qiang Xue committed
295
		if ($this->serializer === null) {
Alexander Makarov committed
296
			$value = serialize([$value, $dependency]);
Qiang Xue committed
297
		} elseif ($this->serializer !== false) {
Alexander Makarov committed
298
			$value = call_user_func($this->serializer[0], [$value, $dependency]);
Qiang Xue committed
299
		}
votintsev committed
300
		$key = $this->buildKey($key);
301
		return $this->addValue($key, $value, $expire);
Qiang Xue committed
302 303 304 305
	}

	/**
	 * Deletes a value with the specified key from cache
306 307
	 * @param mixed $key a key identifying the value to be deleted from cache. This can be a simple string or
	 * a complex data structure consisting of factors representing the key.
Qiang Xue committed
308 309
	 * @return boolean if no error happens during deletion
	 */
310
	public function delete($key)
Qiang Xue committed
311
	{
votintsev committed
312
		$key = $this->buildKey($key);
313
		return $this->deleteValue($key);
Qiang Xue committed
314 315 316 317
	}

	/**
	 * Deletes all values from cache.
Qiang Xue committed
318
	 * Be careful of performing this operation if the cache is shared among multiple applications.
Qiang Xue committed
319 320 321 322 323 324 325 326 327 328
	 * @return boolean whether the flush operation was successful.
	 */
	public function flush()
	{
		return $this->flushValues();
	}

	/**
	 * Retrieves a value from cache with a specified key.
	 * This method should be implemented by child classes to retrieve the data
Qiang Xue committed
329
	 * from specific cache storage.
Qiang Xue committed
330
	 * @param string $key a unique key identifying the cached value
331
	 * @return string|boolean the value stored in cache, false if the value is not in the cache or expired.
Qiang Xue committed
332
	 */
Qiang Xue committed
333
	abstract protected function getValue($key);
Qiang Xue committed
334 335 336 337

	/**
	 * Stores a value identified by a key in cache.
	 * This method should be implemented by child classes to store the data
Qiang Xue committed
338
	 * in specific cache storage.
Qiang Xue committed
339 340 341 342 343
	 * @param string $key the key identifying the value to be cached
	 * @param string $value the value to be cached
	 * @param integer $expire the number of seconds in which the cached value will expire. 0 means never expire.
	 * @return boolean true if the value is successfully stored into cache, false otherwise
	 */
Qiang Xue committed
344
	abstract protected function setValue($key, $value, $expire);
Qiang Xue committed
345 346 347 348

	/**
	 * Stores a value identified by a key into cache if the cache does not contain this key.
	 * This method should be implemented by child classes to store the data
Qiang Xue committed
349
	 * in specific cache storage.
Qiang Xue committed
350 351 352 353 354
	 * @param string $key the key identifying the value to be cached
	 * @param string $value the value to be cached
	 * @param integer $expire the number of seconds in which the cached value will expire. 0 means never expire.
	 * @return boolean true if the value is successfully stored into cache, false otherwise
	 */
Qiang Xue committed
355
	abstract protected function addValue($key, $value, $expire);
Qiang Xue committed
356 357 358 359 360 361 362

	/**
	 * Deletes a value with the specified key from cache
	 * This method should be implemented by child classes to delete the data from actual cache storage.
	 * @param string $key the key of the value to be deleted
	 * @return boolean if no error happens during deletion
	 */
Qiang Xue committed
363
	abstract protected function deleteValue($key);
Qiang Xue committed
364 365 366 367 368 369

	/**
	 * Deletes all values from cache.
	 * Child classes may implement this method to realize the flush operation.
	 * @return boolean whether the flush operation was successful.
	 */
Qiang Xue committed
370 371 372 373 374 375 376 377 378 379 380
	abstract protected function flushValues();

	/**
	 * Retrieves multiple values from cache with the specified keys.
	 * The default implementation calls [[getValue()]] multiple times to retrieve
	 * the cached values one by one. If the underlying cache storage supports multiget,
	 * this method should be overridden to exploit that feature.
	 * @param array $keys a list of keys identifying the cached values
	 * @return array a list of cached values indexed by the keys
	 */
	protected function getValues($keys)
Qiang Xue committed
381
	{
Alexander Makarov committed
382
		$results = [];
Qiang Xue committed
383 384 385 386
		foreach ($keys as $key) {
			$results[$key] = $this->getValue($key);
		}
		return $results;
Qiang Xue committed
387 388
	}

389 390 391
	/**
	 * Stores multiple key-value pairs in cache.
	 * The default implementation calls [[setValue()]] multiple times store values one by one. If the underlying cache
392
	 * storage supports multi-set, this method should be overridden to exploit that feature.
393 394 395 396 397 398 399
	 * @param array $data array where key corresponds to cache key while value is the value stored
	 * @param integer $expire the number of seconds in which the cached values will expire. 0 means never expire.
	 * @return array array of failed keys
	 */
	protected function setValues($data, $expire)
	{
		$failedKeys = [];
400
		foreach ($data as $key => $value) {
401 402 403 404 405 406 407 408 409 410
			if ($this->setValue($key, $value, $expire) === false) {
				$failedKeys[] = $key;
			}
		}
		return $failedKeys;
	}

	/**
	 * Adds multiple key-value pairs to cache.
	 * The default implementation calls [[addValue()]] multiple times add values one by one. If the underlying cache
411
	 * storage supports multi-add, this method should be overridden to exploit that feature.
412 413 414 415 416 417 418
	 * @param array $data array where key corresponds to cache key while value is the value stored
	 * @param integer $expire the number of seconds in which the cached values will expire. 0 means never expire.
	 * @return array array of failed keys
	 */
	protected function addValues($data, $expire)
	{
		$failedKeys = [];
419
		foreach ($data as $key => $value) {
420 421 422 423 424 425 426
			if ($this->addValue($key, $value, $expire) === false) {
				$failedKeys[] = $key;
			}
		}
		return $failedKeys;
	}

Qiang Xue committed
427 428 429
	/**
	 * Returns whether there is a cache entry with a specified key.
	 * This method is required by the interface ArrayAccess.
430
	 * @param string $key a key identifying the cached value
Qiang Xue committed
431 432
	 * @return boolean
	 */
433
	public function offsetExists($key)
Qiang Xue committed
434
	{
435
		return $this->get($key) !== false;
Qiang Xue committed
436 437 438 439 440
	}

	/**
	 * Retrieves the value from cache with a specified key.
	 * This method is required by the interface ArrayAccess.
441
	 * @param string $key a key identifying the cached value
Qiang Xue committed
442 443
	 * @return mixed the value stored in cache, false if the value is not in the cache or expired.
	 */
444
	public function offsetGet($key)
Qiang Xue committed
445
	{
446
		return $this->get($key);
Qiang Xue committed
447 448 449 450 451
	}

	/**
	 * Stores the value identified by a key into cache.
	 * If the cache already contains such a key, the existing value will be
Qiang Xue committed
452
	 * replaced with the new ones. To add expiration and dependencies, use the [[set()]] method.
Qiang Xue committed
453
	 * This method is required by the interface ArrayAccess.
454
	 * @param string $key the key identifying the value to be cached
Qiang Xue committed
455 456
	 * @param mixed $value the value to be cached
	 */
457
	public function offsetSet($key, $value)
Qiang Xue committed
458
	{
459
		$this->set($key, $value);
Qiang Xue committed
460 461 462 463 464
	}

	/**
	 * Deletes the value with the specified key from cache
	 * This method is required by the interface ArrayAccess.
465
	 * @param string $key the key of the value to be deleted
Qiang Xue committed
466
	 */
467
	public function offsetUnset($key)
Qiang Xue committed
468
	{
469
		$this->delete($key);
Qiang Xue committed
470
	}
Zander Baldwin committed
471
}