ar\cache

This module provides a low-level data cache as well as a cache proxy class that can wrap a caching layer around any type of object.

Example 1: simple data caching:

view plaincopy to clipboardprint?
  1. <pinp>  
  2.   if ( !$image = ar('cache')->getIfFresh( 'cached' ) ) {  
  3.     $image = expensiveOperation();  
  4.     ar('cache')->set( 'cached', $image );  
  5.   }  
  6.   echo $image;  
  7. </pinp>  

Example 2: caching http client:

view plaincopy to clipboardprint?
  1. <pinp>  
  2.   $cachingHTTPClient = ar('cache')->proxy(   
  3.     ar('http')->client(),   
  4.     '30 minutes'   
  5.   );  
  6. </pinp>  

Example 3: data caching with horde protection:

view plaincopy to clipboardprint?
  1. <pinp>  
  2.   $cacheName = 'cached_image_name';  
  3.   if ( !$image = ar('cache')->getIfFresh( $cacheName ) ) {  
  4.     if ( ar('cache')->lock( $cacheName ) ) {  
  5.       $image = expensiveOperation();  
  6.       ar('cache')->set( $cacheName, $image, '2 hours' );  
  7.     } else if ( ar('cache')->wait( $cacheName ) ) {  
  8.       // lock failed, so another process is generating the cache  
  9.       // continue here when the lock is released  
  10.       $image = ar('cache')->get( $cacheName );  
  11.     } else {  
  12.       // lock isn't released in a reasonable time  
  13.       // generate an error, reload or in this case use the stale image:  
  14.       $image = ar('cache')->get( $cacheName );  
  15.     }  
  16.   }  
  17.   echo $image;  
  18. </pinp>  

methods

(void)configConfigure default settings, e.g. the default cache store
(object)createReturns a new cache store.
(mixed)getReturns the cached image or null if not available.
(mixed)getIfFreshReturns the cached image only if it is still fresh, as defined when the image was last saved.
(bool)lockTries to acquire a non-blocking lock on the cache image.
(bool)waitWaits for the cache file to become unlocked or a system timeout.
(bool)setStores an image with the given name and freshness.
(mixed)infoReturns information about a cache image.
(bool)clearRemoves a given cache image.
(bool)purgeRemoves a given cache image and all cache images that are children of it.
(object)proxyReturns a new cache proxy object for the given object.

config

view plaincopy to clipboardprint?
  1.