Source for file MemcachedStorage.php

Documentation is available at MemcachedStorage.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette\Caching
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../Object.php';
24:
25: require_once dirname(__FILE__) . '/../Caching/ICacheStorage.php';
26:
27:
28:
29: /**
30: * Memcached storage.
31: *
32: * @author David Grudl
33: * @copyright Copyright (c) 2004, 2009 David Grudl
34: * @package Nette\Caching
35: */
36: class MemcachedStorage extends Object implements ICacheStorage
37: {
38: /**#@+ internal cache structure */
39: const META_CONSTS = 'consts';
40: const META_DATA = 'data';
41: const META_DELTA = 'delta';
42: const META_FILES = 'df';
43: /**#@-*/
44:
45: /** @var Memcache */
46: protected $memcache;
47:
48: /** @var string */
49: protected $prefix;
50:
51:
52:
53: /**
54: * Checks if Memcached extension is available.
55: * @return bool
56: */
57: public static function isAvailable()
58: {
59: return extension_loaded('memcache');
60: }
61:
62:
63:
64: public function __construct($host = 'localhost', $port = 11211, $prefix = '')
65: {
66: if (!self::isAvailable()) {
67: throw new Exception("PHP extension 'memcache' is not loaded.");
68: }
69:
70: $this->prefix = $prefix;
71: $this->memcache = new Memcache;
72: $this->memcache->connect($host, $port);
73: }
74:
75:
76:
77: /**
78: * Read from cache.
79: * @param string key
80: * @return mixed|NULL
81: */
82: public function read($key)
83: {
84: $key = $this->prefix . $key;
85: $meta = $this->memcache->get($key);
86: if (!$meta) return NULL;
87:
88: // meta structure:
89: // array(
90: // data => stored data
91: // delta => relative (sliding) expiration
92: // df => array of dependent files (file => timestamp)
93: // consts => array of constants (const => [value])
94: // )
95:
96: // verify dependencies
97: if (!empty($meta[self::META_CONSTS])) {
98: foreach ($meta[self::META_CONSTS] as $const => $value) {
99: if (!defined($const) || constant($const) !== $value) {
100: $this->memcache->delete($key);
101: return NULL;
102: }
103: }
104: }
105:
106: if (!empty($meta[self::META_FILES])) {
107: //clearstatcache();
108: foreach ($meta[self::META_FILES] as $depFile => $time) {
109: if (@filemtime($depFile) <> $time) {
110: $this->memcache->delete($key);
111: return NULL;
112: }
113: }
114: }
115:
116: if (!empty($meta[self::META_DELTA])) {
117: $this->memcache->replace($key, $meta, 0, $meta[self::META_DELTA] + time());
118: }
119:
120: return $meta[self::META_DATA];
121: }
122:
123:
124:
125: /**
126: * Writes item into the cache.
127: * @param string key
128: * @param mixed data
129: * @param array dependencies
130: * @return bool TRUE if no problem
131: */
132: public function write($key, $data, array $dp)
133: {
134: if (!empty($dp[Cache::TAGS]) || isset($dp[Cache::PRIORITY]) || !empty($dp[Cache::ITEMS])) {
135: throw new NotSupportedException('Tags, priority and dependent items are not supported by MemcachedStorage.');
136: }
137:
138: $meta = array(
139: self::META_DATA => $data,
140: );
141:
142: $expire = 0;
143: if (!empty($dp[Cache::EXPIRE])) {
144: $expire = (int) $dp[Cache::EXPIRE];
145: if ($expire <= Tools::YEAR) {
146: $expire += time();
147: }
148: if (!empty($dp[Cache::REFRESH])) {
149: $meta[self::META_DELTA] = $expire - time(); // sliding time
150: }
151: }
152:
153: if (!empty($dp[Cache::FILES])) {
154: //clearstatcache();
155: foreach ((array) $dp[Cache::FILES] as $depFile) {
156: $meta[self::META_FILES][$depFile] = @filemtime($depFile); // intentionally @
157: }
158: }
159:
160: if (!empty($dp[Cache::CONSTS])) {
161: foreach ((array) $dp[Cache::CONSTS] as $const) {
162: $meta[self::META_CONSTS][$const] = constant($const);
163: }
164: }
165:
166: return $this->memcache->set($this->prefix . $key, $meta, 0, $expire);
167: }
168:
169:
170:
171: /**
172: * Removes item from the cache.
173: * @param string key
174: * @return bool TRUE if no problem
175: */
176: public function remove($key)
177: {
178: return $this->memcache->delete($this->prefix . $key);
179: }
180:
181:
182:
183: /**
184: * Removes items from the cache by conditions & garbage collector.
185: * @param array conditions
186: * @return bool TRUE if no problem
187: */
188: public function clean(array $conds)
189: {
190: if (!empty($conds[Cache::ALL])) {
191: $this->memcache->flush();
192:
193: } elseif (isset($conds[Cache::TAGS]) || isset($conds[Cache::PRIORITY])) {
194: throw new NotSupportedException('Tags and priority is not supported by MemcachedStorage.');
195: }
196:
197: return TRUE;
198: }
199:
200: }

Source for file MemcachedStorage.php

Namespaces