$queueId
$queueId : mixed
The queue ID.
process(callable $callback = null, callable $successCallback = null, callable $failureCallback = null) : boolean
Process the item.
callable | $callback | An optional callback routine executed after the item is processed. |
callable | $successCallback | An optional callback routine executed when the item is resolved. |
callable | $failureCallback | An optional callback routine executed when the item is rejected. |
Success / Failure
setQueueItemData(array $data) : \Charcoal\Queue\QueueItemTrait
Set the queue item's data.
array | $data | The queue item data to set. |
Chainable
setQueueId(mixed $id) : \Charcoal\Queue\QueueItemInterface
Set the queue's ID.
mixed | $id | The unique queue identifier. |
Chainable
setProcessed(boolean $processed) : \Charcoal\Queue\QueueItemInterface
Set the item's processed status.
boolean | $processed | Whether the item has been processed. |
Chainable
setQueuedDate(null|string|\DateTimeInterface $ts) : \Charcoal\Queue\QueueItemInterface
Set the date/time the item was queued at.
null|string|\DateTimeInterface | $ts | A date/time string or object. |
If the date/time is invalid.
Chainable
setProcessingDate(null|string|\DateTimeInterface $ts) : \Charcoal\Queue\QueueItemInterface
Set the date/time the item should be processed at.
null|string|\DateTimeInterface | $ts | A date/time string or object. |
If the date/time is invalid.
Chainable
setProcessedDate(null|string|\DateTimeInterface $ts) : \Charcoal\Queue\QueueItemInterface
Set the date/time the item was processed at.
null|string|\DateTimeInterface | $ts | A date/time string or object. |
If the date/time is invalid.
Chainable
preSaveQueueItem() : \Charcoal\Queue\QueueItemInterface
Hook called before saving the item.
Presets the item as to-be processed and queued now.
Chainable