Wikimedia\ObjectCache\MemoizedCallable Class Reference

APCu-backed function memoization. More...

Public Member Functions
	__construct ( $callable, $ttl=3600)
	invoke (... $params)
	Invoke the memoized function or method.
	invokeArgs (array $args=[])
	Invoke the memoized function or method.

Static Public Member Functions
static	call ( $callable, array $args=[], $ttl=3600)
	Shortcut method for creating a MemoizedCallable and invoking it with the specified arguments.

Protected Member Functions
	fetchResult ( $key, &$success)
	Fetch the result of a previous invocation.
	storeResult ( $key, $result)
	Store the result of an invocation.

Detailed Description

APCu-backed function memoization.

This class provides memoization for pure functions. A function is pure if its result value depends on nothing other than its input parameters and if invoking it does not cause any side-effects.

The first invocation of the memoized callable with a particular set of arguments will be delegated to the underlying callable. Repeat invocations with the same input parameters will be served from APCu.

Example:

$memoizedRange = new MemoizedCallable( 'range' );
$memoizedRange->invoke( 5, 8 );  // result: array( 5, 6, 7, 8 )
$memoizedRange->invokeArgs( array( 5, 8 ) );  // same
MemoizedCallable::call( 'range', array( 5, 8 ) );  // same

Since

1.27

Author

Ori Livneh

Definition at line 35 of file MemoizedCallable.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\ObjectCache\MemoizedCallable::__construct	(		$callable,
			$ttl = 3600 )

Parameters

	callable&string|callable&array	$callable Function or method to memoize. This class does not support Closure objects, as it uses the function/method name as a cache key. To memoize a closure, use Wikimedia\ObjectCache\APCUBagOStuff::getWithSetCallback() instead and pass a unique name for your closure and its parameters to makeGlobalKey.
int	$ttl	TTL in seconds. Defaults to 3600 (1 hour). Capped at 86400 (24 hours).

Definition at line 53 of file MemoizedCallable.php.

Member Function Documentation

call()

static Wikimedia\ObjectCache\MemoizedCallable::call ( $callable, array $args = [], $ttl = 3600 )

static

Shortcut method for creating a MemoizedCallable and invoking it with the specified arguments.

Parameters

	callable&string|callable&array	$callable
array	$args
int	$ttl

Returns

mixed

Definition at line 150 of file MemoizedCallable.php.

fetchResult()

Wikimedia\ObjectCache\MemoizedCallable::fetchResult ( $key, & $success )

protected

Fetch the result of a previous invocation.

Parameters

string	$key
bool	&$success

Returns

bool

Definition at line 80 of file MemoizedCallable.php.

References $success.

Referenced by Wikimedia\ObjectCache\MemoizedCallable\invokeArgs().

invoke()

Wikimedia\ObjectCache\MemoizedCallable::invoke

(

$params

)

Invoke the memoized function or method.

Like MemoizedCallable::invokeArgs(), but variadic.

Parameters

mixed

...$params Parameters for memoized function or method.

Returns

mixed The memoized callable's return value.

Definition at line 137 of file MemoizedCallable.php.

References Wikimedia\ObjectCache\MemoizedCallable\invokeArgs().

invokeArgs()

Wikimedia\ObjectCache\MemoizedCallable::invokeArgs

(

array

$args = []

)

Invoke the memoized function or method.

Exceptions

InvalidArgumentException

If parameters list contains non-scalar items.

Parameters

array

$args

Parameters for memoized function or method.

Returns

mixed The memoized callable's return value.

Definition at line 107 of file MemoizedCallable.php.

References $success, Wikimedia\ObjectCache\MemoizedCallable\fetchResult(), and Wikimedia\ObjectCache\MemoizedCallable\storeResult().

Referenced by Wikimedia\ObjectCache\MemoizedCallable\invoke().

storeResult()

Wikimedia\ObjectCache\MemoizedCallable::storeResult ( $key, $result )

protected

Store the result of an invocation.

Parameters

string	$key
mixed	$result

Definition at line 94 of file MemoizedCallable.php.

Referenced by Wikimedia\ObjectCache\MemoizedCallable\invokeArgs().

---

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

• includes/libs/ObjectCache/MemoizedCallable.php