Methods summary
public
boolean
|
#
process( callable $callback = null, callable $successCallback = null, callable $failureCallback = null )
Process the item.
Parameters
- $callback
- An optional callback routine executed after the item is processed.
- $successCallback
- An optional callback routine executed when the item is resolved.
- $failureCallback
- An optional callback routine executed when the item is rejected.
Returns
boolean Success / Failure
|
public
Charcoal\Queue\QueueItemTrait
|
#
setQueueItemData( array $data )
Set the queue item's data.
Set the queue item's data.
Parameters
- $data
- The queue item data to set.
Returns
|
public
Charcoal\Queue\QueueItemInterface
|
#
setQueueId( mixed $id )
Set the queue's ID.
Parameters
- $id
- The unique queue identifier.
Returns
|
public
string
|
#
queueId( )
Get the queue's ID.
Returns
string
|
public
Charcoal\Queue\QueueItemInterface
|
#
setQueuedDate( null|string|DateTimeInterface $ts )
Set the date/time the item was queued at.
Set the date/time the item was queued at.
Parameters
- $ts
- A date/time string or object.
Returns
|
public
null|DateTimeInterface
|
#
queuedDate( )
Retrieve the date/time the item was queued at.
Retrieve the date/time the item was queued at.
Returns
null|DateTimeInterface
|
public
Charcoal\Queue\QueueItemInterface
|
#
setProcessingDate( null|string|DateTimeInterface $ts )
Set the date/time the item should be processed at.
Set the date/time the item should be processed at.
Parameters
- $ts
- A date/time string or object.
Returns
Throws
InvalidArgumentException If the date/time is invalid.
|
public
null|DateTimeInterface
|
#
processingDate( )
Retrieve the date/time the item should be processed at.
Retrieve the date/time the item should be processed at.
Returns
null|DateTimeInterface
|
public
Charcoal\Queue\QueueItemInterface
|
#
setProcessedDate( null|string|DateTimeInterface $ts )
Set the date/time the item was processed at.
Set the date/time the item was processed at.
Parameters
- $ts
- A date/time string or object.
Returns
Throws
InvalidArgumentException If the date/time is invalid.
|
public
null|DateTimeInterface
|
#
processedDate( )
Retrieve the date/time the item was processed at.
Retrieve the date/time the item was processed at.
Returns
null|DateTimeInterface
|