DependencyWrapper Class Reference

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

Collaboration diagram for DependencyWrapper:

List of all members.

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.
Private Attributes
CacheDependency[]	$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 30 of file CacheDependency.php.

---

Constructor & Destructor Documentation

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

Create an instance.

Parameters:

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

Definition at line 40 of file CacheDependency.php.

---

Member Function Documentation

DependencyWrapper::getValue

(

)

Get the user-defined value.

Returns:

bool|mixed

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

BagOStuff	$cache	A cache object such as $wgMemc
string	$key	The cache key
int	$expiry	The expiry timestamp or interval in seconds
bool | callable	$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 112 of file CacheDependency.php.

DependencyWrapper::initialiseDeps

(

)

Initialise dependency values in preparation for storing.

This must be called before serialization.

Definition at line 69 of file CacheDependency.php.

DependencyWrapper::isExpired

(

)

Returns true if any of the dependencies have expired.

Returns:

bool

Definition at line 55 of file CacheDependency.php.

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

Store the wrapper to a cache.

Parameters:

BagOStuff	$cache
string	$key
int	$expiry

Definition at line 90 of file CacheDependency.php.

---

Member Data Documentation

CacheDependency [] DependencyWrapper::$deps [private]

*

Definition at line 32 of file CacheDependency.php.

DependencyWrapper::$value [private]

Definition at line 31 of file CacheDependency.php.

---

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

• includes/cache/CacheDependency.php