Convenience class for dealing with PoolCounters using callbacks. More...
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 () | |
| A work not so good (eg. | |
| getCachedWork () | |
| Retrieve the work from cache. | |
Protected Attributes | |
| callable null | $doCachedWork |
| * | |
| callable | $doWork |
| * | |
| callable null | $error |
| * | |
| callable null | $fallback |
| * | |
Detailed Description
Convenience class for dealing with PoolCounters using callbacks.
- Since:
- 1.22
Definition at line 155 of file PoolCounterWork.php.
Constructor & Destructor Documentation
| 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.
- Parameters:
-
string $type string $key array $callbacks Map of callbacks
- Exceptions:
-
MWException
Definition at line 175 of file PoolCounterWork.php.
Member Function Documentation
Actually perform the work, caching it if needed.
- Returns:
- mixed work result or false
Reimplemented from PoolCounterWork.
Definition at line 191 of file PoolCounterWork.php.
Referenced by getCachedWork().
| PoolCounterWorkViaCallback::error | ( | $ | status | ) |
Do something with the error, like showing it to the user.
- Returns:
- bool
Reimplemented from PoolCounterWork.
Definition at line 209 of file PoolCounterWork.php.
A work not so good (eg.
expired one) but better than an error message.
- Returns:
- mixed work result or false
Reimplemented from PoolCounterWork.
Definition at line 202 of file PoolCounterWork.php.
Retrieve the work from cache.
- Returns:
- mixed work result or false
Reimplemented from PoolCounterWork.
Definition at line 195 of file PoolCounterWork.php.
Member Data Documentation
callable null PoolCounterWorkViaCallback::$doCachedWork [protected] |
*
Definition at line 157 of file PoolCounterWork.php.
callable PoolCounterWorkViaCallback::$doWork [protected] |
*
Definition at line 156 of file PoolCounterWork.php.
callable null PoolCounterWorkViaCallback::$error [protected] |
*
Definition at line 159 of file PoolCounterWork.php.
callable null PoolCounterWorkViaCallback::$fallback [protected] |
*
Definition at line 158 of file PoolCounterWork.php.
The documentation for this class was generated from the following file:
- includes/poolcounter/PoolCounterWork.php
