Packages

  • Nette
    • Application
      • Diagnostics
      • Responses
      • Routers
      • UI
    • Caching
      • Storages
    • ComponentModel
    • Config
      • Adapters
      • Extensions
    • Database
      • Diagnostics
      • Drivers
      • Reflection
      • Table
    • DI
      • Diagnostics
    • Diagnostics
    • Forms
      • Controls
      • Rendering
    • Http
    • Iterators
    • Latte
      • Macros
    • Loaders
    • Localization
    • Mail
    • Reflection
    • Security
      • Diagnostics
    • Templating
    • Utils
      • PhpGenerator
  • NetteModule
  • None
  • PHP

Classes

  • Cache
  • CachingHelper

Interfaces

  • ICacheStorage
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  1: <?php
  2: 
  3: /**
  4:  * This file is part of the Nette Framework (http://nette.org)
  5:  *
  6:  * Copyright (c) 2004 David Grudl (http://davidgrudl.com)
  7:  *
  8:  * For the full copyright and license information, please view
  9:  * the file license.txt that was distributed with this source code.
 10:  * @package Nette\Caching
 11:  */
 12: 
 13: 
 14: 
 15: /**
 16:  * Implements the cache for a application.
 17:  *
 18:  * @author     David Grudl
 19:  *
 20:  * @property-read ICacheStorage $storage
 21:  * @property-read string $namespace
 22:  * @package Nette\Caching
 23:  */
 24: class Cache extends Object implements ArrayAccess
 25: {
 26:     /** dependency */
 27:     const PRIORITY = 'priority',
 28:         EXPIRATION = 'expire',
 29:         EXPIRE = 'expire',
 30:         SLIDING = 'sliding',
 31:         TAGS = 'tags',
 32:         FILES = 'files',
 33:         ITEMS = 'items',
 34:         CONSTS = 'consts',
 35:         CALLBACKS = 'callbacks',
 36:         ALL = 'all';
 37: 
 38:     /** @internal */
 39:     const NAMESPACE_SEPARATOR = "\x00";
 40: 
 41:     /** @var ICacheStorage */
 42:     private $storage;
 43: 
 44:     /** @var string */
 45:     private $namespace;
 46: 
 47:     /** @var string  last query cache used by offsetGet() */
 48:     private $key;
 49: 
 50:     /** @var mixed  last query cache used by offsetGet()  */
 51:     private $data;
 52: 
 53: 
 54: 
 55:     public function __construct(ICacheStorage $storage, $namespace = NULL)
 56:     {
 57:         $this->storage = $storage;
 58:         $this->namespace = $namespace . self::NAMESPACE_SEPARATOR;
 59:     }
 60: 
 61: 
 62: 
 63:     /**
 64:      * Returns cache storage.
 65:      * @return ICacheStorage
 66:      */
 67:     public function getStorage()
 68:     {
 69:         return $this->storage;
 70:     }
 71: 
 72: 
 73: 
 74:     /**
 75:      * Returns cache namespace.
 76:      * @return string
 77:      */
 78:     public function getNamespace()
 79:     {
 80:         return (string) substr($this->namespace, 0, -1);
 81:     }
 82: 
 83: 
 84: 
 85:     /**
 86:      * Returns new nested cache object.
 87:      * @param  string
 88:      * @return Cache
 89:      */
 90:     public function derive($namespace)
 91:     {
 92:         $derived = new self($this->storage, $this->namespace . $namespace);
 93:         return $derived;
 94:     }
 95: 
 96: 
 97: 
 98:     /**
 99:      * Reads the specified item from the cache or generate it.
100:      * @param  mixed key
101:      * @param  callable
102:      * @return mixed|NULL
103:      */
104:     public function load($key, $fallback = NULL)
105:     {
106:         $data = $this->storage->read($this->generateKey($key));
107:         if ($data === NULL && $fallback) {
108:             return $this->save($key, new Callback($fallback));
109:         }
110:         return $data;
111:     }
112: 
113: 
114: 
115:     /**
116:      * Writes item into the cache.
117:      * Dependencies are:
118:      * - Cache::PRIORITY => (int) priority
119:      * - Cache::EXPIRATION => (timestamp) expiration
120:      * - Cache::SLIDING => (bool) use sliding expiration?
121:      * - Cache::TAGS => (array) tags
122:      * - Cache::FILES => (array|string) file names
123:      * - Cache::ITEMS => (array|string) cache items
124:      * - Cache::CONSTS => (array|string) cache items
125:      *
126:      * @param  mixed  key
127:      * @param  mixed  value
128:      * @param  array  dependencies
129:      * @return mixed  value itself
130:      * @throws InvalidArgumentException
131:      */
132:     public function save($key, $data, array $dp = NULL)
133:     {
134:         $this->release();
135:         $key = $this->generateKey($key);
136: 
137:         if ($data instanceof Callback || $data instanceof Closure) {
138:             $this->storage->lock($key);
139:             $data = Callback::create($data)->invokeArgs(array(&$dp));
140:         }
141: 
142:         if ($data === NULL) {
143:             $this->storage->remove($key);
144:         } else {
145:             $this->storage->write($key, $data, $this->completeDependencies($dp, $data));
146:             return $data;
147:         }
148:     }
149: 
150: 
151: 
152:     private function completeDependencies($dp, $data)
153:     {
154:         if (is_object($data)) {
155:             $dp[self::CALLBACKS][] = array(array(__CLASS__, 'checkSerializationVersion'), get_class($data),
156:                 ClassReflection::from($data)->getAnnotation('serializationVersion'));
157:         }
158: 
159:         // convert expire into relative amount of seconds
160:         if (isset($dp[Cache::EXPIRATION])) {
161:             $dp[Cache::EXPIRATION] = DateTime53::from($dp[Cache::EXPIRATION])->format('U') - time();
162:         }
163: 
164:         // convert FILES into CALLBACKS
165:         if (isset($dp[self::FILES])) {
166:             //clearstatcache();
167:             foreach (array_unique((array) $dp[self::FILES]) as $item) {
168:                 $dp[self::CALLBACKS][] = array(array(__CLASS__, 'checkFile'), $item, @filemtime($item)); // @ - stat may fail
169:             }
170:             unset($dp[self::FILES]);
171:         }
172: 
173:         // add namespaces to items
174:         if (isset($dp[self::ITEMS])) {
175:             $dp[self::ITEMS] = array_unique(array_map(array($this, 'generateKey'), (array) $dp[self::ITEMS]));
176:         }
177: 
178:         // convert CONSTS into CALLBACKS
179:         if (isset($dp[self::CONSTS])) {
180:             foreach (array_unique((array) $dp[self::CONSTS]) as $item) {
181:                 $dp[self::CALLBACKS][] = array(array(__CLASS__, 'checkConst'), $item, constant($item));
182:             }
183:             unset($dp[self::CONSTS]);
184:         }
185: 
186:         if (!is_array($dp)) {
187:             $dp = array();
188:         }
189:         return $dp;
190:     }
191: 
192: 
193: 
194:     /**
195:      * Removes item from the cache.
196:      * @param  mixed  key
197:      * @return void
198:      */
199:     public function remove($key)
200:     {
201:         $this->save($key, NULL);
202:     }
203: 
204: 
205: 
206:     /**
207:      * Removes items from the cache by conditions.
208:      * Conditions are:
209:      * - Cache::PRIORITY => (int) priority
210:      * - Cache::TAGS => (array) tags
211:      * - Cache::ALL => TRUE
212:      *
213:      * @param  array
214:      * @return void
215:      */
216:     public function clean(array $conds = NULL)
217:     {
218:         $this->release();
219:         $this->storage->clean((array) $conds);
220:     }
221: 
222: 
223: 
224:     /**
225:      * Caches results of function/method calls.
226:      * @param  mixed
227:      * @return mixed
228:      */
229:     public function call($function)
230:     {
231:         $key = func_get_args();
232:         return $this->load($key, create_function('', 'extract($GLOBALS[0]['.array_push($GLOBALS[0], array('function'=>$function,'key'=> $key)).'-1], EXTR_REFS);
233:             array_shift($key);
234:             return Callback::create($function)->invokeArgs($key);
235:         '));
236:     }
237: 
238: 
239: 
240:     /**
241:      * Caches results of function/method calls.
242:      * @param  mixed
243:      * @param  array  dependencies
244:      * @return Closure
245:      */
246:     public function wrap($function, array $dp = NULL)
247:     {
248:         $cache = $this;
249:         return create_function('', 'extract($GLOBALS[0]['.array_push($GLOBALS[0], array('cache'=>$cache,'function'=> $function,'dp'=> $dp)).'-1], EXTR_REFS);
250:             $_args=func_get_args(); $key = array($function, $_args);
251:             $data = $cache->load($key);
252:             if ($data === NULL) {
253:                 $data = $cache->save($key, Callback::create($function)->invokeArgs($key[1]), $dp);
254:             }
255:             return $data;
256:         ');
257:     }
258: 
259: 
260: 
261:     /**
262:      * Starts the output cache.
263:      * @param  mixed  key
264:      * @return CachingHelper|NULL
265:      */
266:     public function start($key)
267:     {
268:         $data = $this->load($key);
269:         if ($data === NULL) {
270:             return new CachingHelper($this, $key);
271:         }
272:         echo $data;
273:     }
274: 
275: 
276: 
277:     /**
278:      * Generates internal cache key.
279:      *
280:      * @param  string
281:      * @return string
282:      */
283:     protected function generateKey($key)
284:     {
285:         return $this->namespace . md5(is_scalar($key) ? $key : serialize($key));
286:     }
287: 
288: 
289: 
290:     /********************* interface ArrayAccess ****************d*g**/
291: 
292: 
293: 
294:     /**
295:      * Inserts (replaces) item into the cache (ArrayAccess implementation).
296:      * @param  mixed key
297:      * @param  mixed
298:      * @return void
299:      * @throws InvalidArgumentException
300:      */
301:     public function offsetSet($key, $data)
302:     {
303:         $this->save($key, $data);
304:     }
305: 
306: 
307: 
308:     /**
309:      * Retrieves the specified item from the cache or NULL if the key is not found (ArrayAccess implementation).
310:      * @param  mixed key
311:      * @return mixed|NULL
312:      * @throws InvalidArgumentException
313:      */
314:     public function offsetGet($key)
315:     {
316:         $key = is_scalar($key) ? (string) $key : serialize($key);
317:         if ($this->key !== $key) {
318:             $this->key = $key;
319:             $this->data = $this->load($key);
320:         }
321:         return $this->data;
322:     }
323: 
324: 
325: 
326:     /**
327:      * Exists item in cache? (ArrayAccess implementation).
328:      * @param  mixed key
329:      * @return bool
330:      * @throws InvalidArgumentException
331:      */
332:     public function offsetExists($key)
333:     {
334:         $this->release();
335:         return $this->offsetGet($key) !== NULL;
336:     }
337: 
338: 
339: 
340:     /**
341:      * Removes the specified item from the cache.
342:      * @param  mixed key
343:      * @return void
344:      * @throws InvalidArgumentException
345:      */
346:     public function offsetUnset($key)
347:     {
348:         $this->save($key, NULL);
349:     }
350: 
351: 
352: 
353:     /**
354:      * Discards the internal cache used by ArrayAccess.
355:      * @return void
356:      */
357:     public function release()
358:     {
359:         $this->key = $this->data = NULL;
360:     }
361: 
362: 
363: 
364:     /********************* dependency checkers ****************d*g**/
365: 
366: 
367: 
368:     /**
369:      * Checks CALLBACKS dependencies.
370:      * @param  array
371:      * @return bool
372:      */
373:     public static function checkCallbacks($callbacks)
374:     {
375:         foreach ($callbacks as $callback) {
376:             $func = array_shift($callback);
377:             if (!call_user_func_array($func, $callback)) {
378:                 return FALSE;
379:             }
380:         }
381:         return TRUE;
382:     }
383: 
384: 
385: 
386:     /**
387:      * Checks CONSTS dependency.
388:      * @param  string
389:      * @param  mixed
390:      * @return bool
391:      */
392:     private static function checkConst($const, $value)
393:     {
394:         return defined($const) && constant($const) === $value;
395:     }
396: 
397: 
398: 
399:     /**
400:      * Checks FILES dependency.
401:      * @param  string
402:      * @param  int
403:      * @return bool
404:      */
405:     private static function checkFile($file, $time)
406:     {
407:         return @filemtime($file) == $time; // @ - stat may fail
408:     }
409: 
410: 
411: 
412:     /**
413:      * Checks object @serializationVersion label.
414:      * @param  string
415:      * @param  mixed
416:      * @return bool
417:      */
418:     private static function checkSerializationVersion($class, $value)
419:     {
420:         return ClassReflection::from($class)->getAnnotation('serializationVersion') === $value;
421:     }
422: 
423: }
424: 
Nette Framework 2.0.8 (for PHP 5.2, un-prefixed) API API documentation generated by ApiGen 2.8.0