Cache Class Reference

The Cache class provides a simple caching interface. More...

Static Public Member Functions
static	getInstance ()
static	get ($key)
	Retrieve the specified object from the cache. More...
static	put ($key, $obj, $ttl=0)
	Store the specified object in the cache at the specified key. More...
static	invalidate ($key)
	Invalidates the specifed entry in the cache. More...
static	invalidateMatching ($pattern)
	Invalidate all entries in the cache that match a specific pattern. More...
static	clear ()
	Clear the cache, deleting all records. More...
static	dump ()
	Output a dump of the cache for debugging purposes. More...

Static Public Attributes
static	$instance
static	$app_name

Detailed Description

The Cache class provides a simple caching interface.

If APC is installed and enabled, caching will be done through APC and will be available across page accesses. If APC is not available, a simple in-memory hash is used.

Author

Andy Green

Definition at line 41 of file cache.inc.

Member Function Documentation

clear()

static Cache::clear ( )

static

Clear the cache, deleting all records.

Definition at line 141 of file cache.inc.

     {
          return Cache::getInstance()->clear();
     }

dump()

static Cache::dump ( )

static

Output a dump of the cache for debugging purposes.

Definition at line 149 of file cache.inc.

     {
          return Cache::getInstance()->dump();
     }

get()

static Cache::get (   $key )

static

Retrieve the specified object from the cache.

Parameters

string

$key

the key identifying the object

Returns

mixed the associated object, or null if no match was found

Definition at line 88 of file cache.inc.

     {
          return Cache::getInstance()->get(ConnectionManager::$dsn."_".Cache::$app_name."_".$key);
     }

getInstance()

static Cache::getInstance ( )

static

Definition at line 46 of file cache.inc.

     {
          global $config;
          
          trace(get_class(Cache::$instance), 5);
          
          if (Cache::$instance) return Cache::$instance;
          
          if (array_key_exists("file_backed_cache_directory", $config))
          {
               Cache::$instance = new FileBackedCache();
          }
          else if (ini_get("apc.enabled") && PHP_SAPI !== 'cli')
          {
               if (PHP_MAJOR_VERSION >= 7)
               {
                    Cache::$instance = new APCUCache();
               }
               else
               {
                    Cache::$instance = new APCCache();
               }
          }
          else if (ini_get("wincache.ucenabled") && PHP_SAPI !== 'cli')
          {
               Cache::$instance = new WCCache();
          }
          else
          {
               Cache::$instance = new SimpleMemoryCache();
          }
 
          Cache::$app_name = codify($config['sitename']);
          
          return Cache::$instance;
     }

invalidate()

static Cache::invalidate (   $key )

static

Invalidates the specifed entry in the cache.

This can be used to flag items in the cache that have potentially been updated by other actions. These items are removed from the cache upon invalidation. If the item has not been cached, no action is taken.

Parameters

string

$key

the entry to be invalidated

Definition at line 119 of file cache.inc.

     {
          return Cache::getInstance()->invalidate(ConnectionManager::$dsn."_".Cache::$app_name."_".$key);
     }

invalidateMatching()

static Cache::invalidateMatching (   $pattern )

static

Invalidate all entries in the cache that match a specific pattern.

This can be used to flag items in the cache that have potentially been updated by other actions. These items are removed from the cache upon invalidation. If the item has not been cached, no action is taken.

Parameters

string

$pattern

PCRE describing the matching keys

Definition at line 133 of file cache.inc.

     {
          return Cache::getInstance()->invalidateMatching("^".ConnectionManager::$dsn."_".Cache::$app_name."_".$pattern);
     }

put()

static Cache::put (   $key,   $obj,   $ttl = 0  )

static

Store the specified object in the cache at the specified key.

If APC cacheing is enabled then this value will be available to subsequent script invocations, and the $ttl parameter can optionally be used to specify the time-to-live of the cache record. If APC is enabled and the TTL is not specified then the item will stay in the cache until it is invalidated. If APC is not enabled then the item will only remain in the cache for the rest of this script invocation.

Parameters

string	$key	the key that the value will be cached under.
mixed	$obj	the object or value to be cached
integer	$ttl	the time-to-live for the cache entry, in seconds

Definition at line 106 of file cache.inc.

     {
          return Cache::getInstance()->put(ConnectionManager::$dsn."_".Cache::$app_name."_".$key, $obj, $ttl);
     }

Member Data Documentation

$app_name

Cache::$app_name

static

Definition at line 44 of file cache.inc.

$instance

Cache::$instance

static

Definition at line 43 of file cache.inc.

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/framework/cache.inc