Source for file Cache.php

Documentation is available at Cache.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:
26:
27: /**
28: * Implements the cache for a application.
29: *
30: * @author David Grudl
31: * @copyright Copyright (c) 2004, 2009 David Grudl
32: * @package Nette\Caching
33: */
34: class Cache extends Object implements ArrayAccess
35: {
36: /**#@+ dependency */
37: const PRIORITY = 'priority';
38: const EXPIRE = 'expire';
39: const REFRESH = 'refresh';
40: const TAGS = 'tags';
41: const FILES = 'files';
42: const ITEMS = 'items';
43: const CONSTS = 'consts';
44: const ALL = 'all';
45: /**#@-*/
46:
47: /** @var ICacheStorage */
48: private $storage;
49:
50: /** @var string */
51: private $namespace;
52:
53: /** @var string last query cache */
54: private $key;
55:
56: /** @var mixed last query cache */
57: private $data;
58:
59:
60:
61: public function __construct(ICacheStorage $storage, $namespace = NULL)
62: {
63: $this->storage = $storage;
64: $this->namespace = $namespace == NULL ? '' : $namespace . "\x00";
65: }
66:
67:
68:
69: /**
70: * Returns cache storage.
71: * @return ICacheStorage
72: */
73: public function getStorage()
74: {
75: return $this->storage;
76: }
77:
78:
79:
80: /**
81: * Returns cache namespace.
82: * @return string
83: */
84: public function getNamespace()
85: {
86: return $this->namespace;
87: }
88:
89:
90:
91: /**
92: * Discards the internal cache.
93: * @return void
94: */
95: public function release()
96: {
97: $this->key = $this->data = NULL;
98: }
99:
100:
101:
102: /**
103: * Writes item into the cache.
104: * Dependencies are:
105: * priority => (int) priority
106: * expire => (timestamp) expiration
107: * refresh => (bool) use sliding expiration?
108: * tags => (array) tags
109: * files => (array|string) file names
110: * items => (array|string) cache items
111: * consts => (array|string) cache items
112: *
113: * @param string key
114: * @param mixed
115: * @param array
116: * @return void
117: * @throws InvalidArgumentException
118: */
119: public function save($key, $data, array $dependencies = NULL)
120: {
121: if (!is_string($key)) {
122: throw new InvalidArgumentException("Cache key name must be string, " . gettype($key) ." given.");
123: }
124:
125: $this->key = NULL;
126:
127: $this->adjust($dependencies);
128:
129: $this->storage->write(
130: $this->namespace . $key,
131: $data,
132: $dependencies
133: );
134: }
135:
136:
137:
138: /**
139: * Removes items from the cache by conditions.
140: * @param array
141: * @return void
142: */
143: public function clean(array $conds = NULL)
144: {
145: $this->adjust($conds);
146: $this->storage->clean($conds);
147:
148:
149:
150:
151: /**
152: * Update dependencies array.
153: * @param array
154: * @return void
155: */
156: private function adjust(& $arr)
157: {
158: if ($arr === NULL) {
159: $arr = array();
160: }
161:
162: if (isset($arr[self::TAGS])) {
163: $arr[self::TAGS] = (array) $arr[self::TAGS];
164: foreach ($arr[self::TAGS] as $key => $value) {
165: $arr[self::TAGS][$key] = $this->namespace . $value;
166: }
167: }
168:
169: if (isset($arr[self::ITEMS])) {
170: $arr[self::ITEMS] = (array) $arr[self::ITEMS];
171: foreach ($arr[self::ITEMS] as $key => $value) {
172: $arr[self::ITEMS][$key] = $this->namespace . $value;
173: }
174: }
175: }
176:
177:
178:
179: /********************* interface \ArrayAccess ****************d*g**/
180:
181:
182:
183: /**
184: * Inserts (replaces) item into the cache (\ArrayAccess implementation).
185: * @param string key
186: * @param mixed
187: * @return void
188: * @throws InvalidArgumentException
189: */
190: public function offsetSet($key, $data)
191: {
192: if (!is_string($key)) { // prevents NULL
193: throw new InvalidArgumentException("Cache key name must be string, " . gettype($key) ." given.");
194: }
195:
196: $this->key = $this->data = NULL;
197: if ($data === NULL) {
198: $this->storage->remove($this->namespace . $key);
199: } else {
200: $this->storage->write($this->namespace . $key, $data, array());
201: }
202: }
203:
204:
205:
206: /**
207: * Retrieves the specified item from the cache or NULL if the key is not found (\ArrayAccess implementation).
208: * @param string key
209: * @return mixed|NULL
210: * @throws InvalidArgumentException
211: */
212: public function offsetGet($key)
213: {
214: if (!is_string($key)) {
215: throw new InvalidArgumentException("Cache key name must be string, " . gettype($key) ." given.");
216: }
217:
218: if ($this->key === $key) {
219: return $this->data;
220: }
221: $this->key = $key;
222: $this->data = $this->storage->read($this->namespace . $key);
223: return $this->data;
224: }
225:
226:
227:
228: /**
229: * Exists item in cache? (\ArrayAccess implementation).
230: * @param string key
231: * @return bool
232: * @throws InvalidArgumentException
233: */
234: public function offsetExists($key)
235: {
236: if (!is_string($key)) {
237: throw new InvalidArgumentException("Cache key name must be string, " . gettype($key) ." given.");
238: }
239:
240: $this->key = $key;
241: $this->data = $this->storage->read($this->namespace . $key);
242: return $this->data !== NULL;
243: }
244:
245:
246:
247: /**
248: * Removes the specified item from the cache.
249: * @param string key
250: * @return void
251: * @throws InvalidArgumentException
252: */
253: public function offsetUnset($key)
254: {
255: if (!is_string($key)) {
256: throw new InvalidArgumentException("Cache key name must be string, " . gettype($key) ." given.");
257: }
258:
259: $this->key = $this->data = NULL;
260: $this->storage->remove($this->namespace . $key);
261: }
262:
263: }

Source for file Cache.php

Namespaces