DependencyWrapper Class Reference
[Cache]

This class stores an arbitrary value along with its dependencies. More...

List of all members.

Public Member Functions

 __construct ($value=false, $deps=array())
 Create an instance.
 isExpired ()
 Returns true if any of the dependencies have expired.
 initialiseDeps ()
 Initialise dependency values in preparation for storing.
 getValue ()
 Get the user-defined value.
 storeToCache ($cache, $key, $expiry=0)
 Store the wrapper to a cache.

Static Public Member Functions

static getValueFromCache ($cache, $key, $expiry=0, $callback=false, $callbackParams=array(), $deps=array())
 Attempt to get a value from the cache.

Public Attributes

 $value
 $deps


Detailed Description

This class stores an arbitrary value along with its dependencies.

Users should typically only use DependencyWrapper::getFromCache(), rather than instantiating one of these objects directly.

Definition at line 9 of file CacheDependency.php.


Constructor & Destructor Documentation

DependencyWrapper::__construct ( value = false,
deps = array() 
)

Create an instance.

Parameters:
mixed $value The user-supplied value
mixed $deps A dependency or dependency array. All dependencies must be objects implementing CacheDependency.

Definition at line 19 of file CacheDependency.php.

References $deps, and $value.


Member Function Documentation

DependencyWrapper::getValue (  ) 

Get the user-defined value.

Definition at line 52 of file CacheDependency.php.

static DependencyWrapper::getValueFromCache ( cache,
key,
expiry = 0,
callback = false,
callbackParams = array(),
deps = array() 
) [static]

Attempt to get a value from the cache.

If the value is expired or missing, it will be generated with the callback function (if present), and the newly calculated value will be stored to the cache in a wrapper.

Parameters:
object $cache A cache object such as $wgMemc
string $key The cache key
integer $expiry The expiry timestamp or interval in seconds
mixed $callback The callback for generating the value, or false
array $callbackParams The function parameters for the callback
array $deps The dependencies to store on a cache miss. Note: these are not the dependencies used on a cache hit! Cache hits use the stored dependency array.
Returns:
mixed The value, or null if it was not present in the cache and no callback was defined.

Definition at line 81 of file CacheDependency.php.

References $deps, $key, $obj, and $value.

DependencyWrapper::initialiseDeps (  ) 

Initialise dependency values in preparation for storing.

This must be called before serialization.

Definition at line 43 of file CacheDependency.php.

Referenced by storeToCache().

DependencyWrapper::isExpired (  ) 

Returns true if any of the dependencies have expired.

Definition at line 30 of file CacheDependency.php.

DependencyWrapper::storeToCache ( cache,
key,
expiry = 0 
)

Store the wrapper to a cache.

Definition at line 59 of file CacheDependency.php.

References $key, and initialiseDeps().


Member Data Documentation

DependencyWrapper::$deps

Definition at line 11 of file CacheDependency.php.

Referenced by __construct(), and getValueFromCache().

DependencyWrapper::$value

Definition at line 10 of file CacheDependency.php.

Referenced by __construct(), and getValueFromCache().


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

Generated on Sat Sep 5 02:08:36 2009 for MediaWiki by  doxygen 1.5.9