ApcCache.php 4.99 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
 * ApcCache provides APC caching in terms of an application component.
Qiang Xue committed
12
 *
13
 * To use this application component, the [APC PHP extension](http://www.php.net/apc) must be loaded.
14
 * In order to enable APC for CLI you should add "apc.enable_cli = 1" to your php.ini.
Qiang Xue committed
15
 *
16
 * See [[Cache]] for common cache operations that ApcCache supports.
Qiang Xue committed
17 18
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
19
 * @since 2.0
Qiang Xue committed
20
 */
21
class ApcCache extends Cache
Qiang Xue committed
22
{
23 24 25 26 27 28
    /**
     * 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.
     * 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.
29 30
     * @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.
31 32 33 34 35
     * @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);
Qiang Xue committed
36

37 38
        return apc_exists($key);
    }
Qiang Xue committed
39

40 41 42
    /**
     * Retrieves a value from cache with a specified key.
     * This is the implementation of the method declared in the parent class.
43
     * @param string $key a unique key identifying the cached value
44 45 46 47 48 49
     * @return string|boolean the value stored in cache, false if the value is not in the cache or expired.
     */
    protected function getValue($key)
    {
        return apc_fetch($key);
    }
Qiang Xue committed
50

51 52
    /**
     * Retrieves multiple values from cache with the specified keys.
53
     * @param array $keys a list of keys identifying the cached values
54 55 56 57
     * @return array a list of cached values indexed by the keys
     */
    protected function getValues($keys)
    {
58
        $values = apc_fetch($keys);
59
        return is_array($values) ? $values : [];
60
    }
Qiang Xue committed
61

62 63 64 65
    /**
     * Stores a value identified by a key in cache.
     * This is the implementation of the method declared in the parent class.
     *
66 67 68
     * @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.
69 70
     * @return boolean true if the value is successfully stored into cache, false otherwise
     */
Qiang Xue committed
71
    protected function setValue($key, $value, $duration)
72
    {
Qiang Xue committed
73
        return apc_store($key, $value, $duration);
74
    }
75

76 77
    /**
     * Stores multiple key-value pairs in cache.
78 79 80
     * @param array $data array where key corresponds to cache key while value
     * @param integer $duration the number of seconds in which the cached values will expire. 0 means never expire.
     * @return array array of failed keys
81
     */
Qiang Xue committed
82
    protected function setValues($data, $duration)
83
    {
84 85
        $result = apc_store($data, null, $duration);
        return is_array($result) ? array_keys($result) : [];
86
    }
Qiang Xue committed
87

88 89 90
    /**
     * 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.
91 92 93
     * @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.
94 95
     * @return boolean true if the value is successfully stored into cache, false otherwise
     */
Qiang Xue committed
96
    protected function addValue($key, $value, $duration)
97
    {
Qiang Xue committed
98
        return apc_add($key, $value, $duration);
99
    }
100

101 102
    /**
     * Adds multiple key-value pairs to cache.
103 104 105
     * @param array $data array where key corresponds to cache key while value is the value stored
     * @param integer $duration the number of seconds in which the cached values will expire. 0 means never expire.
     * @return array array of failed keys
106
     */
Qiang Xue committed
107
    protected function addValues($data, $duration)
108
    {
109 110
        $result = apc_add($data, null, $duration);
        return is_array($result) ? array_keys($result) : [];
111
    }
Qiang Xue committed
112

113 114 115
    /**
     * Deletes a value with the specified key from cache
     * This is the implementation of the method declared in the parent class.
116
     * @param string $key the key of the value to be deleted
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
     * @return boolean if no error happens during deletion
     */
    protected function deleteValue($key)
    {
        return apc_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()
    {
        if (extension_loaded('apcu')) {
            return apc_clear_cache();
        } else {
            return apc_clear_cache('user');
        }
    }
Qiang Xue committed
137
}