Namespaces

  • 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
  • OutputHelper

Interfaces

  • IStorage
  • Overview
  • Namespace
  • 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:  */
 11: 
 12: namespace Nette\Caching;
 13: 
 14: use Nette;
 15: 
 16: 
 17: 
 18: /**
 19:  * Implements the cache for a application.
 20:  *
 21:  * @author     David Grudl
 22:  *
 23:  * @property-read IStorage $storage
 24:  * @property-read string $namespace
 25:  */
 26: class Cache extends Nette\Object implements \ArrayAccess
 27: {
 28:     /** dependency */
 29:     const PRIORITY = 'priority',
 30:         EXPIRATION = 'expire',
 31:         EXPIRE = 'expire',
 32:         SLIDING = 'sliding',
 33:         TAGS = 'tags',
 34:         FILES = 'files',
 35:         ITEMS = 'items',
 36:         CONSTS = 'consts',
 37:         CALLBACKS = 'callbacks',
 38:         ALL = 'all';
 39: 
 40:     /** @internal */
 41:     const NAMESPACE_SEPARATOR = "\x00";
 42: 
 43:     /** @var IStorage */
 44:     private $storage;
 45: 
 46:     /** @var string */
 47:     private $namespace;
 48: 
 49:     /** @var string  last query cache used by offsetGet() */
 50:     private $key;
 51: 
 52:     /** @var mixed  last query cache used by offsetGet()  */
 53:     private $data;
 54: 
 55: 
 56: 
 57:     public function __construct(IStorage $storage, $namespace = NULL)
 58:     {
 59:         $this->storage = $storage;
 60:         $this->namespace = $namespace . self::NAMESPACE_SEPARATOR;
 61:     }
 62: 
 63: 
 64: 
 65:     /**
 66:      * Returns cache storage.
 67:      * @return IStorage
 68:      */
 69:     public function getStorage()
 70:     {
 71:         return $this->storage;
 72:     }
 73: 
 74: 
 75: 
 76:     /**
 77:      * Returns cache namespace.
 78:      * @return string
 79:      */
 80:     public function getNamespace()
 81:     {
 82:         return (string) substr($this->namespace, 0, -1);
 83:     }
 84: 
 85: 
 86: 
 87:     /**
 88:      * Returns new nested cache object.
 89:      * @param  string
 90:      * @return Cache
 91:      */
 92:     public function derive($namespace)
 93:     {
 94:         $derived = new static($this->storage, $this->namespace . $namespace);
 95:         return $derived;
 96:     }
 97: 
 98: 
 99: 
100:     /**
101:      * Reads the specified item from the cache or generate it.
102:      * @param  mixed key
103:      * @param  callable
104:      * @return mixed|NULL
105:      */
106:     public function load($key, $fallback = NULL)
107:     {
108:         $data = $this->storage->read($this->generateKey($key));
109:         if ($data === NULL && $fallback) {
110:             return $this->save($key, new Nette\Callback($fallback));
111:         }
112:         return $data;
113:     }
114: 
115: 
116: 
117:     /**
118:      * Writes item into the cache.
119:      * Dependencies are:
120:      * - Cache::PRIORITY => (int) priority
121:      * - Cache::EXPIRATION => (timestamp) expiration
122:      * - Cache::SLIDING => (bool) use sliding expiration?
123:      * - Cache::TAGS => (array) tags
124:      * - Cache::FILES => (array|string) file names
125:      * - Cache::ITEMS => (array|string) cache items
126:      * - Cache::CONSTS => (array|string) cache items
127:      *
128:      * @param  mixed  key
129:      * @param  mixed  value
130:      * @param  array  dependencies
131:      * @return mixed  value itself
132:      * @throws Nette\InvalidArgumentException
133:      */
134:     public function save($key, $data, array $dependencies = NULL)
135:     {
136:         $this->release();
137:         $key = $this->generateKey($key);
138: 
139:         if ($data instanceof Nette\Callback || $data instanceof \Closure) {
140:             $this->storage->lock($key);
141:             $data = Nette\Callback::create($data)->invokeArgs(array(&$dependencies));
142:         }
143: 
144:         if ($data === NULL) {
145:             $this->storage->remove($key);
146:         } else {
147:             $this->storage->write($key, $data, $this->completeDependencies($dependencies, $data));
148:             return $data;
149:         }
150:     }
151: 
152: 
153: 
154:     private function completeDependencies($dp, $data)
155:     {
156:         if (is_object($data)) {
157:             $dp[self::CALLBACKS][] = array(array(__CLASS__, 'checkSerializationVersion'), get_class($data),
158:                 Nette\Reflection\ClassType::from($data)->getAnnotation('serializationVersion'));
159:         }
160: 
161:         // convert expire into relative amount of seconds
162:         if (isset($dp[Cache::EXPIRATION])) {
163:             $dp[Cache::EXPIRATION] = Nette\DateTime::from($dp[Cache::EXPIRATION])->format('U') - time();
164:         }
165: 
166:         // convert FILES into CALLBACKS
167:         if (isset($dp[self::FILES])) {
168:             //clearstatcache();
169:             foreach (array_unique((array) $dp[self::FILES]) as $item) {
170:                 $dp[self::CALLBACKS][] = array(array(__CLASS__, 'checkFile'), $item, @filemtime($item)); // @ - stat may fail
171:             }
172:             unset($dp[self::FILES]);
173:         }
174: 
175:         // add namespaces to items
176:         if (isset($dp[self::ITEMS])) {
177:             $dp[self::ITEMS] = array_unique(array_map(array($this, 'generateKey'), (array) $dp[self::ITEMS]));
178:         }
179: 
180:         // convert CONSTS into CALLBACKS
181:         if (isset($dp[self::CONSTS])) {
182:             foreach (array_unique((array) $dp[self::CONSTS]) as $item) {
183:                 $dp[self::CALLBACKS][] = array(array(__CLASS__, 'checkConst'), $item, constant($item));
184:             }
185:             unset($dp[self::CONSTS]);
186:         }
187: 
188:         if (!is_array($dp)) {
189:             $dp = array();
190:         }
191:         return $dp;
192:     }
193: 
194: 
195: 
196:     /**
197:      * Removes item from the cache.
198:      * @param  mixed  key
199:      * @return void
200:      */
201:     public function remove($key)
202:     {
203:         $this->save($key, NULL);
204:     }
205: 
206: 
207: 
208:     /**
209:      * Removes items from the cache by conditions.
210:      * Conditions are:
211:      * - Cache::PRIORITY => (int) priority
212:      * - Cache::TAGS => (array) tags
213:      * - Cache::ALL => TRUE
214:      * @return void
215:      */
216:     public function clean(array $conditions = NULL)
217:     {
218:         $this->release();
219:         $this->storage->clean((array) $conditions);
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, function() use ($function, $key) {
233:             array_shift($key);
234:             return Nette\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 $dependencies = NULL)
247:     {
248:         $cache = $this;
249:         return function() use ($cache, $function, $dependencies) {
250:             $key = array($function, func_get_args());
251:             $data = $cache->load($key);
252:             if ($data === NULL) {
253:                 $data = $cache->save($key, Nette\Callback::create($function)->invokeArgs($key[1]), $dependencies);
254:             }
255:             return $data;
256:         };
257:     }
258: 
259: 
260: 
261:     /**
262:      * Starts the output cache.
263:      * @param  mixed  key
264:      * @return OutputHelper|NULL
265:      */
266:     public function start($key)
267:     {
268:         $data = $this->load($key);
269:         if ($data === NULL) {
270:             return new OutputHelper($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 Nette\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 Nette\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 Nette\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 Nette\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 Nette\Reflection\ClassType::from($class)->getAnnotation('serializationVersion') === $value;
421:     }
422: 
423: }
424: 
Nette Framework 2.0.10 API API documentation generated by ApiGen 2.8.0