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

Public Member Functions
	__construct ($value=false, $deps=array())
	Create an instance.
	getValue ()
	Get the user-defined value.
	initialiseDeps ()
	Initialise dependency values in preparation for storing.
	isExpired ()
	Returns true if any of the dependencies have expired.
	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
	$deps
	$value

Detailed Description

This class stores an arbitrary value along with its dependencies.

Users should typically only use DependencyWrapper::getValueFromCache(), 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:

$value	Mixed: the user-supplied value
$deps	Mixed: 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.

Returns:: bool|

Definition at line 58 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:

$cache	BagOStuff a cache object such as $wgMemc
$key	String: the cache key
$expiry	Integer: the expiry timestamp or interval in seconds
$callback	Mixed: the callback for generating the value, or false
$callbackParams	Array: the function parameters for the callback
$deps	Array: 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.