ZendDataCache.php 2.95 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;

Qiang Xue committed
10
/**
11
 * ZendDataCache provides Zend data caching in terms of an application component.
Qiang Xue committed
12
 *
Alexander Makarov committed
13
 * To use this application component, the [Zend Data Cache PHP extension](http://www.zend.com/en/products/server/)
14
 * must be loaded.
Qiang Xue committed
15
 *
16
 * See [[Cache]] for common cache operations that ZendDataCache supports.
Qiang Xue committed
17
 *
Qiang Xue committed
18 19
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
Qiang Xue committed
20
 */
21
class ZendDataCache extends Cache
Qiang Xue committed
22
{
23 24 25
    /**
     * Retrieves a value from cache with a specified key.
     * This is the implementation of the method declared in the parent class.
26
     * @param string $key a unique key identifying the cached value
27 28 29 30 31
     * @return string|boolean the value stored in cache, false if the value is not in the cache or expired.
     */
    protected function getValue($key)
    {
        $result = zend_shm_cache_fetch($key);
Qiang Xue committed
32

33 34
        return $result === null ? false : $result;
    }
Qiang Xue committed
35

36 37 38 39
    /**
     * Stores a value identified by a key in cache.
     * This is the implementation of the method declared in the parent class.
     *
40 41 42
     * @param string $key the key identifying the value to be cached
     * @param string $value the value to be cached
     * @param integer $duration the number of seconds in which the cached value will expire. 0 means never expire.
43 44
     * @return boolean true if the value is successfully stored into cache, false otherwise
     */
Qiang Xue committed
45
    protected function setValue($key, $value, $duration)
46
    {
Qiang Xue committed
47
        return zend_shm_cache_store($key, $value, $duration);
48
    }
Qiang Xue committed
49

50 51 52 53
    /**
     * Stores a value identified by a key into cache if the cache does not contain this key.
     * This is the implementation of the method declared in the parent class.
     *
54 55 56
     * @param string $key the key identifying the value to be cached
     * @param string $value the value to be cached
     * @param integer $duration the number of seconds in which the cached value will expire. 0 means never expire.
57 58
     * @return boolean true if the value is successfully stored into cache, false otherwise
     */
Qiang Xue committed
59
    protected function addValue($key, $value, $duration)
60
    {
Qiang Xue committed
61
        return zend_shm_cache_fetch($key) === null ? $this->setValue($key, $value, $duration) : false;
62
    }
Qiang Xue committed
63

64 65 66
    /**
     * Deletes a value with the specified key from cache
     * This is the implementation of the method declared in the parent class.
67
     * @param string $key the key of the value to be deleted
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
     * @return boolean if no error happens during deletion
     */
    protected function deleteValue($key)
    {
        return zend_shm_cache_delete($key);
    }

    /**
     * Deletes all values from cache.
     * This is the implementation of the method declared in the parent class.
     * @return boolean whether the flush operation was successful.
     */
    protected function flushValues()
    {
        return zend_shm_cache_clear();
    }
Qiang Xue committed
84
}