\Charcoal\QueueQueueItemInterface

Summary

Methods

Constants

process()
setQueueItemData()
setQueueId()
queueId()
setQueuedDate()
queuedDate()
setProcessingDate()
processingDate()
setProcessedDate()
processedDate()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

process()

process(callable  $callback = null, callable  $successCallback = null, callable  $failureCallback = null) : boolean

Process the item.

Parameters

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.

Returns

boolean —

Success / Failure

setQueueItemData()

setQueueItemData(array  $data) : \Charcoal\Queue\QueueItemTrait

Set the queue item's data.

Parameters

array

$data

The queue item data to set.

Returns

\Charcoal\Queue\QueueItemTrait —

Chainable

setQueueId()

setQueueId(mixed  $id) : \Charcoal\Queue\QueueItemInterface

Set the queue's ID.

Parameters

mixed

$id

The unique queue identifier.

Returns

\Charcoal\Queue\QueueItemInterface —

Chainable

queueId()

queueId() : string

Get the queue's ID.

Returns

string

setQueuedDate()

setQueuedDate(null|string|\Charcoal\Queue\DateTimeInterface  $ts) : \Charcoal\Queue\QueueItemInterface

Set the date/time the item was queued at.

Parameters

null|string|\Charcoal\Queue\DateTimeInterface

$ts

A date/time string or object.

Returns

\Charcoal\Queue\QueueItemInterface —

Chainable

queuedDate()

queuedDate() : null|\Charcoal\Queue\DateTimeInterface

Retrieve the date/time the item was queued at.

Returns

null|\Charcoal\Queue\DateTimeInterface

setProcessingDate()

setProcessingDate(null|string|\Charcoal\Queue\DateTimeInterface  $ts) : \Charcoal\Queue\QueueItemInterface

Set the date/time the item should be processed at.

Parameters

null|string|\Charcoal\Queue\DateTimeInterface

$ts

A date/time string or object.

Throws

\Charcoal\Queue\InvalidArgumentException: If the date/time is invalid.

Returns

\Charcoal\Queue\QueueItemInterface —

Chainable

processingDate()

processingDate() : null|\Charcoal\Queue\DateTimeInterface

Retrieve the date/time the item should be processed at.

Returns

null|\Charcoal\Queue\DateTimeInterface

setProcessedDate()

setProcessedDate(null|string|\Charcoal\Queue\DateTimeInterface  $ts) : \Charcoal\Queue\QueueItemInterface

Set the date/time the item was processed at.

Parameters

null|string|\Charcoal\Queue\DateTimeInterface

$ts

A date/time string or object.

Throws

\Charcoal\Queue\InvalidArgumentException: If the date/time is invalid.

Returns

\Charcoal\Queue\QueueItemInterface —

Chainable

processedDate()

processedDate() : null|\Charcoal\Queue\DateTimeInterface

Retrieve the date/time the item was processed at.

Returns

null|\Charcoal\Queue\DateTimeInterface