MemCache.php 8.77 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
{
	/**
	 * @var boolean whether to use memcached or memcache as the underlying caching extension.
67 68
	 * If true, [memcached](http://pecl.php.net/package/memcached) will be used.
	 * If false, [memcache](http://pecl.php.net/package/memcache) will be used.
Qiang Xue committed
69 70
	 * Defaults to false.
	 */
71
	public $useMemcached = false;
Qiang Xue committed
72
	/**
Qiang Xue committed
73
	 * @var \Memcache|\Memcached the Memcache instance
Qiang Xue committed
74
	 */
75
	private $_cache = null;
Qiang Xue committed
76 77 78
	/**
	 * @var array list of memcache server configurations
	 */
Alexander Makarov committed
79
	private $_servers = [];
Qiang Xue committed
80 81 82 83 84 85 86 87

	/**
	 * Initializes this application component.
	 * It creates the memcache instance and adds memcache servers.
	 */
	public function init()
	{
		parent::init();
88 89
		$servers = $this->getServers();
		$cache = $this->getMemCache();
90 91 92 93 94 95 96 97
		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();
			}
98
			foreach ($servers as $server) {
Qiang Xue committed
99
				if ($server->host === null) {
100
					throw new InvalidConfigException("The 'host' property must be specified for every memcache server.");
Qiang Xue committed
101
				}
102 103 104
				if ($this->useMemcached) {
					$cache->addServer($server->host, $server->port, $server->weight);
				} else {
105 106
					// $timeout is used for memcache versions that do not have timeoutms parameter
					$timeout = (int) ($server->timeout / 1000) + (($server->timeout % 1000 > 0) ? 1 : 0);
107 108 109 110 111 112 113 114 115 116 117 118 119
					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
						);
					}
120
				}
Qiang Xue committed
121 122 123 124 125
			}
		}
	}

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

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

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

	/**
	 * Retrieves a value from cache with a specified key.
	 * This is the implementation of the method declared in the parent class.
	 * @param string $key a unique key identifying the cached value
167
	 * @return string|boolean the value stored in cache, false if the value is not in the cache or expired.
Qiang Xue committed
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
	 */
	protected function getValue($key)
	{
		return $this->_cache->get($key);
	}

	/**
	 * Retrieves multiple values from cache with the specified keys.
	 * @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)
	{
		return $this->useMemcached ? $this->_cache->getMulti($keys) : $this->_cache->get($keys);
	}

	/**
	 * Stores a value identified by a key in cache.
	 * This is the implementation of the method declared in the parent class.
	 *
	 * @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
	 */
193
	protected function setValue($key, $value, $expire)
Qiang Xue committed
194
	{
195 196 197 198 199
		if ($expire > 0) {
			$expire += time();
		} else {
			$expire = 0;
		}
Qiang Xue committed
200

201
		return $this->useMemcached ? $this->_cache->set($key, $value, $expire) : $this->_cache->set($key, $value, 0, $expire);
Qiang Xue committed
202 203
	}

204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
	/**
	 * Stores multiple key-value pairs in cache.
	 * @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. Always empty in case of using memcached.
	 */
	protected function setValues($data, $expire)
	{
		if ($this->useMemcached) {
			if ($expire > 0) {
				$expire += time();
			} else {
				$expire = 0;
			}
			$this->_cache->setMulti($data, $expire);
			return [];
		} else {
			return parent::setValues($data, $expire);
		}
	}

Qiang Xue committed
225 226 227 228 229 230 231 232 233
	/**
	 * 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.
	 *
	 * @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
	 */
234
	protected function addValue($key, $value, $expire)
Qiang Xue committed
235
	{
236 237 238 239 240
		if ($expire > 0) {
			$expire += time();
		} else {
			$expire = 0;
		}
Qiang Xue committed
241

242
		return $this->useMemcached ? $this->_cache->add($key, $value, $expire) : $this->_cache->add($key, $value, 0, $expire);
Qiang Xue committed
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
	}

	/**
	 * Deletes a value with the specified key from cache
	 * This is the implementation of the method declared in the parent class.
	 * @param string $key the key of the value to be deleted
	 * @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();
	}
}