MemCache.php 9.67 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\base\InvalidConfigException;
Qiang Xue committed
11

Qiang Xue committed
12
/**
Qiang Xue committed
13 14 15 16 17 18
 * MemCache implements a cache application component based on [memcache](http://pecl.php.net/package/memcache)
 * and [memcached](http://pecl.php.net/package/memcached).
 *
 * MemCache supports both [memcache](http://pecl.php.net/package/memcache) and
 * [memcached](http://pecl.php.net/package/memcached). By setting [[useMemcached]] to be true or false,
 * one can let MemCache to use either memcached or memcache, respectively.
Qiang Xue committed
19
 *
Qiang Xue committed
20 21
 * MemCache can be configured with a list of memcache servers by settings its [[servers]] property.
 * By default, MemCache assumes there is a memcache server running on localhost at port 11211.
Qiang Xue committed
22
 *
23
 * See [[Cache]] for common cache operations that MemCache supports.
Qiang Xue committed
24 25 26 27
 *
 * Note, there is no security measure to protected data in memcache.
 * All data in memcache can be accessed by any process running in the system.
 *
28
 * To use MemCache as the cache application component, configure the application as follows,
Qiang Xue committed
29 30
 *
 * ~~~
Alexander Makarov committed
31 32 33
 * [
 *     'components' => [
 *         'cache' => [
Qiang Xue committed
34
 *             'class' => 'yii\caching\MemCache',
Alexander Makarov committed
35 36
 *             'servers' => [
 *                 [
resurtm committed
37 38 39
 *                     'host' => 'server1',
 *                     'port' => 11211,
 *                     'weight' => 60,
Alexander Makarov committed
40 41
 *                 ],
 *                 [
resurtm committed
42 43 44
 *                     'host' => 'server2',
 *                     'port' => 11211,
 *                     'weight' => 40,
Alexander Makarov committed
45 46 47 48 49
 *                 ],
 *             ],
 *         ],
 *     ],
 * ]
Qiang Xue committed
50
 * ~~~
Qiang Xue committed
51
 *
Qiang Xue committed
52 53
 * In the above, two memcache servers are used: server1 and server2. You can configure more properties of
 * each server, such as `persistent`, `weight`, `timeout`. Please see [[MemCacheServer]] for available options.
Qiang Xue committed
54
 *
55
 * @property \Memcache|\Memcached $memcache The memcache (or memcached) object used by this cache component.
56 57 58
 * This property is read-only.
 * @property MemCacheServer[] $servers List of memcache server configurations. Note that the type of this
 * property differs in getter and setter. See [[getServers()]] and [[setServers()]] for details.
Qiang Xue committed
59 60
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
61
 * @since 2.0
Qiang Xue committed
62
 */
63
class MemCache extends Cache
Qiang Xue committed
64
{
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
    /**
     * @var boolean whether to use memcached or memcache as the underlying caching extension.
     * If true, [memcached](http://pecl.php.net/package/memcached) will be used.
     * If false, [memcache](http://pecl.php.net/package/memcache) will be used.
     * Defaults to false.
     */
    public $useMemcached = false;
    /**
     * @var \Memcache|\Memcached the Memcache instance
     */
    private $_cache = null;
    /**
     * @var array list of memcache server configurations
     */
    private $_servers = [];
Qiang Xue committed
80

81

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
    /**
     * Initializes this application component.
     * It creates the memcache instance and adds memcache servers.
     */
    public function init()
    {
        parent::init();
        $servers = $this->getServers();
        $cache = $this->getMemCache();
        if (empty($servers)) {
            $cache->addServer('127.0.0.1', 11211);
        } else {
            if (!$this->useMemcached) {
                // different version of memcache may have different number of parameters for the addServer method.
                $class = new \ReflectionClass($cache);
                $paramCount = $class->getMethod('addServer')->getNumberOfParameters();
            }
            foreach ($servers as $server) {
                if ($server->host === null) {
                    throw new InvalidConfigException("The 'host' property must be specified for every memcache server.");
                }
                if ($this->useMemcached) {
                    $cache->addServer($server->host, $server->port, $server->weight);
                } else {
                    // $timeout is used for memcache versions that do not have timeoutms parameter
                    $timeout = (int) ($server->timeout / 1000) + (($server->timeout % 1000 > 0) ? 1 : 0);
                    if ($paramCount === 9) {
                        $cache->addServer(
                            $server->host, $server->port, $server->persistent,
                            $server->weight, $timeout, $server->retryInterval,
                            $server->status, $server->failureCallback, $server->timeout
                        );
                    } else {
                        $cache->addServer(
                            $server->host, $server->port, $server->persistent,
                            $server->weight, $timeout, $server->retryInterval,
                            $server->status, $server->failureCallback
                        );
                    }
                }
            }
        }
    }
Qiang Xue committed
125

126 127
    /**
     * Returns the underlying memcache (or memcached) object.
128
     * @return \Memcache|\Memcached the memcache (or memcached) object used by this cache component.
129 130 131 132 133 134 135 136 137 138 139
     * @throws InvalidConfigException if memcache or memcached extension is not loaded
     */
    public function getMemcache()
    {
        if ($this->_cache === null) {
            $extension = $this->useMemcached ? 'memcached' : 'memcache';
            if (!extension_loaded($extension)) {
                throw new InvalidConfigException("MemCache requires PHP $extension extension to be loaded.");
            }
            $this->_cache = $this->useMemcached ? new \Memcached : new \Memcache;
        }
Qiang Xue committed
140

141 142
        return $this->_cache;
    }
Qiang Xue committed
143

144 145 146 147 148 149 150 151
    /**
     * Returns the memcache server configurations.
     * @return MemCacheServer[] list of memcache server configurations.
     */
    public function getServers()
    {
        return $this->_servers;
    }
Qiang Xue committed
152

153 154
    /**
     * @param array $config list of memcache server configurations. Each element must be an array
155
     * with the following keys: host, port, persistent, weight, timeout, retryInterval, status.
156 157 158 159 160 161 162 163
     * @see http://www.php.net/manual/en/function.Memcache-addServer.php
     */
    public function setServers($config)
    {
        foreach ($config as $c) {
            $this->_servers[] = new MemCacheServer($c);
        }
    }
Qiang Xue committed
164

165 166 167
    /**
     * Retrieves a value from cache with a specified key.
     * This is the implementation of the method declared in the parent class.
168
     * @param string $key a unique key identifying the cached value
169 170 171 172 173 174
     * @return string|boolean the value stored in cache, false if the value is not in the cache or expired.
     */
    protected function getValue($key)
    {
        return $this->_cache->get($key);
    }
Qiang Xue committed
175

176 177
    /**
     * Retrieves multiple values from cache with the specified keys.
178
     * @param array $keys a list of keys identifying the cached values
179 180 181 182 183 184
     * @return array a list of cached values indexed by the keys
     */
    protected function getValues($keys)
    {
        return $this->useMemcached ? $this->_cache->getMulti($keys) : $this->_cache->get($keys);
    }
Qiang Xue committed
185

186 187 188 189
    /**
     * Stores a value identified by a key in cache.
     * This is the implementation of the method declared in the parent class.
     *
190 191 192
     * @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.
193 194
     * @return boolean true if the value is successfully stored into cache, false otherwise
     */
Qiang Xue committed
195
    protected function setValue($key, $value, $duration)
196
    {
Qiang Xue committed
197
        $expire = $duration > 0 ? $duration + time() : 0;
198

199 200
        return $this->useMemcached ? $this->_cache->set($key, $value, $expire) : $this->_cache->set($key, $value, 0, $expire);
    }
201

202 203
    /**
     * Stores multiple key-value pairs in cache.
204 205 206
     * @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. Always empty in case of using memcached.
207
     */
Qiang Xue committed
208
    protected function setValues($data, $duration)
209 210
    {
        if ($this->useMemcached) {
Qiang Xue committed
211
            $this->_cache->setMulti($data, $duration > 0 ? $duration + time() : 0);
212

213 214
            return [];
        } else {
Qiang Xue committed
215
            return parent::setValues($data, $duration);
216 217
        }
    }
Qiang Xue committed
218

219 220 221 222
    /**
     * 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.
     *
223 224 225
     * @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.
226 227
     * @return boolean true if the value is successfully stored into cache, false otherwise
     */
Qiang Xue committed
228
    protected function addValue($key, $value, $duration)
229
    {
Qiang Xue committed
230
        $expire = $duration > 0 ? $duration + time() : 0;
231

232 233 234 235 236 237
        return $this->useMemcached ? $this->_cache->add($key, $value, $expire) : $this->_cache->add($key, $value, 0, $expire);
    }

    /**
     * Deletes a value with the specified key from cache
     * This is the implementation of the method declared in the parent class.
238
     * @param string $key the key of the value to be deleted
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
     * @return boolean if no error happens during deletion
     */
    protected function deleteValue($key)
    {
        return $this->_cache->delete($key, 0);
    }

    /**
     * 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 $this->_cache->flush();
    }
Qiang Xue committed
255
}