Class for dealing with PoolCounters using class members. More...
Public Member Functions | |
| __construct ($type, $key) | |
| doWork () | |
| Actually perform the work, caching it if needed. | |
| error ($status) | |
| Do something with the error, like showing it to the user. | |
| execute ($skipcache=false) | |
| Get the result of the work (whatever it is), or the result of the error() function. | |
| fallback () | |
| A work not so good (eg. | |
| getCachedWork () | |
| Retrieve the work from cache. | |
| logError ($status) | |
| Log an error. | |
Protected Attributes | |
| $cacheable = false | |
Detailed Description
Class for dealing with PoolCounters using class members.
Definition at line 137 of file PoolCounter.php.
Constructor & Destructor Documentation
| PoolCounterWork::__construct | ( | $ | type, |
| $ | key | ||
| ) |
- Parameters:
-
string $type The type of PoolCounter to use string $key Key that identifies the queue this work is placed on
Definition at line 144 of file PoolCounter.php.
Member Function Documentation
| PoolCounterWork::doWork | ( | ) | [abstract] |
Actually perform the work, caching it if needed.
- Returns:
- mixed work result or false
Reimplemented in PoolWorkArticleView, and PoolCounterWorkViaCallback.
| PoolCounterWork::error | ( | $ | status | ) |
Do something with the error, like showing it to the user.
- Returns:
- bool
Reimplemented in PoolWorkArticleView, and PoolCounterWorkViaCallback.
Definition at line 175 of file PoolCounter.php.
| PoolCounterWork::execute | ( | $ | skipcache = false | ) |
Get the result of the work (whatever it is), or the result of the error() function.
This returns the result of the first applicable method that returns a non-false value, where the methods are checked in the following order:
- a) doWork() : Applies if the work is exclusive or no another process is doing it, and on the condition that either this process successfully entered the pool or the pool counter is down.
- b) doCachedWork() : Applies if the work is cacheable and this blocked on another process which finished the work.
- c) fallback() : Applies for all remaining cases. If these all fall through (by returning false), then the result of error() is returned.
- Parameters:
-
$skipcache bool
- Returns:
- mixed
Definition at line 204 of file PoolCounter.php.
A work not so good (eg.
expired one) but better than an error message.
- Returns:
- mixed work result or false
Reimplemented in PoolWorkArticleView, and PoolCounterWorkViaCallback.
Definition at line 167 of file PoolCounter.php.
Retrieve the work from cache.
- Returns:
- mixed work result or false
Reimplemented in PoolWorkArticleView, and PoolCounterWorkViaCallback.
Definition at line 158 of file PoolCounter.php.
| PoolCounterWork::logError | ( | $ | status | ) |
Log an error.
- Parameters:
-
$status Status
- Returns:
- void
Definition at line 185 of file PoolCounter.php.
Member Data Documentation
PoolCounterWork::$cacheable = false [protected] |
Definition at line 138 of file PoolCounter.php.
The documentation for this class was generated from the following file:
- includes/PoolCounter.php
