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 $dp = 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(&$dp));
142:         }
143: 
144:         if ($data === NULL) {
145:             $this->storage->remove($key);
146:         } else {
147:             $this->storage->write($key, $data, $this->completeDependencies($dp, $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:      *
215:      * @param  array
216:      * @return void
217:      */
218:     public function clean(array $conds = NULL)
219:     {
220:         $this->release();
221:         $this->storage->clean((array) $conds);
222:     }
223: 
224: 
225: 
226:     /**
227:      * Caches results of function/method calls.
228:      * @param  mixed
229:      * @return mixed
230:      */
231:     public function call($function)
232:     {
233:         $key = func_get_args();
234:         return $this->load($key, function() use ($function, $key) {
235:             array_shift($key);
236:             return Nette\Callback::create($function)->invokeArgs($key);
237:         });
238:     }
239: 
240: 
241: 
242:     /**
243:      * Caches results of function/method calls.
244:      * @param  mixed
245:      * @param  array  dependencies
246:      * @return Closure
247:      */
248:     public function wrap($function, array $dp = NULL)
249:     {
250:         $cache = $this;
251:         return function() use ($cache, $function, $dp) {
252:             $key = array($function, func_get_args());
253:             $data = $cache->load($key);
254:             if ($data === NULL) {
255:                 $data = $cache->save($key, Nette\Callback::create($function)->invokeArgs($key[1]), $dp);
256:             }
257:             return $data;
258:         };
259:     }
260: 
261: 
262: 
263:     /**
264:      * Starts the output cache.
265:      * @param  mixed  key
266:      * @return OutputHelper|NULL
267:      */
268:     public function start($key)
269:     {
270:         $data = $this->load($key);
271:         if ($data === NULL) {
272:             return new OutputHelper($this, $key);
273:         }
274:         echo $data;
275:     }
276: 
277: 
278: 
279:     /**
280:      * Generates internal cache key.
281:      *
282:      * @param  string
283:      * @return string
284:      */
285:     protected function generateKey($key)
286:     {
287:         return $this->namespace . md5(is_scalar($key) ? $key : serialize($key));
288:     }
289: 
290: 
291: 
292:     /********************* interface ArrayAccess ****************d*g**/
293: 
294: 
295: 
296:     /**
297:      * Inserts (replaces) item into the cache (\ArrayAccess implementation).
298:      * @param  mixed key
299:      * @param  mixed
300:      * @return void
301:      * @throws Nette\InvalidArgumentException
302:      */
303:     public function offsetSet($key, $data)
304:     {
305:         $this->save($key, $data);
306:     }
307: 
308: 
309: 
310:     /**
311:      * Retrieves the specified item from the cache or NULL if the key is not found (\ArrayAccess implementation).
312:      * @param  mixed key
313:      * @return mixed|NULL
314:      * @throws Nette\InvalidArgumentException
315:      */
316:     public function offsetGet($key)
317:     {
318:         $key = is_scalar($key) ? (string) $key : serialize($key);
319:         if ($this->key !== $key) {
320:             $this->key = $key;
321:             $this->data = $this->load($key);
322:         }
323:         return $this->data;
324:     }
325: 
326: 
327: 
328:     /**
329:      * Exists item in cache? (\ArrayAccess implementation).
330:      * @param  mixed key
331:      * @return bool
332:      * @throws Nette\InvalidArgumentException
333:      */
334:     public function offsetExists($key)
335:     {
336:         $this->release();
337:         return $this->offsetGet($key) !== NULL;
338:     }
339: 
340: 
341: 
342:     /**
343:      * Removes the specified item from the cache.
344:      * @param  mixed key
345:      * @return void
346:      * @throws Nette\InvalidArgumentException
347:      */
348:     public function offsetUnset($key)
349:     {
350:         $this->save($key, NULL);
351:     }
352: 
353: 
354: 
355:     /**
356:      * Discards the internal cache used by ArrayAccess.
357:      * @return void
358:      */
359:     public function release()
360:     {
361:         $this->key = $this->data = NULL;
362:     }
363: 
364: 
365: 
366:     /********************* dependency checkers ****************d*g**/
367: 
368: 
369: 
370:     /**
371:      * Checks CALLBACKS dependencies.
372:      * @param  array
373:      * @return bool
374:      */
375:     public static function checkCallbacks($callbacks)
376:     {
377:         foreach ($callbacks as $callback) {
378:             $func = array_shift($callback);
379:             if (!call_user_func_array($func, $callback)) {
380:                 return FALSE;
381:             }
382:         }
383:         return TRUE;
384:     }
385: 
386: 
387: 
388:     /**
389:      * Checks CONSTS dependency.
390:      * @param  string
391:      * @param  mixed
392:      * @return bool
393:      */
394:     private static function checkConst($const, $value)
395:     {
396:         return defined($const) && constant($const) === $value;
397:     }
398: 
399: 
400: 
401:     /**
402:      * Checks FILES dependency.
403:      * @param  string
404:      * @param  int
405:      * @return bool
406:      */
407:     private static function checkFile($file, $time)
408:     {
409:         return @filemtime($file) == $time; // @ - stat may fail
410:     }
411: 
412: 
413: 
414:     /**
415:      * Checks object @serializationVersion label.
416:      * @param  string
417:      * @param  mixed
418:      * @return bool
419:      */
420:     private static function checkSerializationVersion($class, $value)
421:     {
422:         return Nette\Reflection\ClassType::from($class)->getAnnotation('serializationVersion') === $value;
423:     }
424: 
425: }
426: 
Nette Framework 2.0.8 API API documentation generated by ApiGen 2.8.0