public function AcquiaPurgeQueueStatusInterface::getStatus in Acquia Purge 7
Get the current or general status of this object.
New, freshly claimed queue items area always in the NULL context. This context is normal when the queue item doesn't yet float from executor to executor, and is called the "general context". calling ::getStatus() will then evaluate the "global" status for the object.
However, the behaviors of ::getStatus() and ::setStatus() change after a call to ::setStatusContext(). From this point on, both will respectively retrieve and store the status *specific* to that executor context. Context switching is done by AcquiaPurgeService::process() and therefore simple executor implementations don't require thorough understanding of this concept.
Return value
int
- AcquiaPurgeQueueStatusInterface::FRESH
- AcquiaPurgeQueueStatusInterface::FAILED
- AcquiaPurgeQueueStatusInterface::SUCCEEDED
File
- lib/
queue/ AcquiaPurgeQueueStatusInterface.php, line 50
Class
- AcquiaPurgeQueueStatusInterface
- Describes objects capable of letting multiple actors set a SUCCEEDED or FAILED status, which can then be evaluated to a single overall outcome.
Code
public function getStatus();