Convenience class for dealing with PoolCounters using callbacks. More...

Inheritance diagram for PoolCounterWorkViaCallback:

Collaboration diagram for PoolCounterWorkViaCallback:

[legend]

Public Member Functions
	__construct ( $type, $key, array $callbacks)
	Build a PoolCounterWork class from a type, key, and callback map.

	doWork ()
	Actually perform the work, caching it if needed.

	error ( $status)
	Do something with the error, like showing it to the user.

	fallback ( $fast)
	A work not so good (eg.

	getCachedWork ()
	Retrieve the work from cache.

Public Member Functions inherited from PoolCounterWork
	__construct (string $type, string $key, PoolCounter $poolCounter=null)

	execute ( $skipcache=false)
	Get the result of the work (whatever it is), or the result of the error() function.

	logError ( $status)
	Log an error.

Protected Attributes
callable null	$doCachedWork

callable	$doWork

callable null	$error

callable null	$fallback

Protected Attributes inherited from PoolCounterWork
bool	$cacheable = false

string	$type = 'generic'

Additional Inherited Members
Protected Member Functions inherited from PoolCounterWork
	isFastStaleEnabled ()
	Should fast stale mode be used?

Detailed Description

Convenience class for dealing with PoolCounters using callbacks.

Since: 1.22 @newable

Note: marked as newable in 1.35 for lack of a better alternative, but should use a factory in the future.

Definition at line 31 of file PoolCounterWorkViaCallback.php.

Constructor & Destructor Documentation

◆ __construct()

PoolCounterWorkViaCallback::__construct	(		$type,
			$key,
		array	$callbacks
	)

Build a PoolCounterWork class from a type, key, and callback map.

The callback map must at least have a callback for the 'doWork' method. Additionally, callbacks can be provided for the 'doCachedWork', 'fallback', and 'error' methods. Methods without callbacks will be no-ops that return false. If a 'doCachedWork' callback is provided, then execute() may wait for any prior process in the pool to finish and reuse its cached result.