API Documentation
\
Charcoal
Queue

\Charcoal\QueueQueueItemTrait

Summary

Methods
Properties
Constants
process()
setQueueItemData()
setQueueId()
queueId()
setProcessed()
processed()
setQueuedDate()
queuedDate()
setProcessingDate()
processingDate()
setProcessedDate()
processedDate()
preSaveQueueItem()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$queueId
$processed
$queuedDate
$processingDate
$processedDate
N/A

Properties

$queueId

$queueId : mixed

The queue ID.

Type

mixed

$processed

$processed : boolean

Whether the item has been processed.

Type

boolean

$queuedDate

$queuedDate : \DateTimeInterface

When the item was queued.

Type

\DateTimeInterface

$processingDate

$processingDate : \DateTimeInterface

When the item should be processed.

The date/time at which this queue item job should be ran. If NULL, 0, or a past date/time, then it should be performed immediately.

Type

\DateTimeInterface

$processedDate

$processedDate : \DateTimeInterface

When the item was processed.

Type

\DateTimeInterface

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() : mixed

Get the queue's ID.

Returns

mixed

setProcessed()

setProcessed(boolean  $processed) : \Charcoal\Queue\QueueItemInterface

Set the item's processed status.

Parameters

boolean $processed

Whether the item has been processed.

Returns

\Charcoal\Queue\QueueItemInterface —

Chainable

processed()

processed() : boolean

Determine if the item has been processed.

Returns

boolean

setQueuedDate()

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

Set the date/time the item was queued at.

Parameters

null|string|\DateTimeInterface $ts

A date/time string or object.

Throws

\InvalidArgumentException

If the date/time is invalid.

Returns

\Charcoal\Queue\QueueItemInterface —

Chainable

queuedDate()

queuedDate() : null|\DateTimeInterface

Retrieve the date/time the item was queued at.

Returns

null|\DateTimeInterface

setProcessingDate()

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

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

Parameters

null|string|\DateTimeInterface $ts

A date/time string or object.

Throws

\InvalidArgumentException

If the date/time is invalid.

Returns

\Charcoal\Queue\QueueItemInterface —

Chainable

processingDate()

processingDate() : null|\DateTimeInterface

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

Returns

null|\DateTimeInterface

setProcessedDate()

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

Set the date/time the item was processed at.

Parameters

null|string|\DateTimeInterface $ts

A date/time string or object.

Throws

\InvalidArgumentException

If the date/time is invalid.

Returns

\Charcoal\Queue\QueueItemInterface —

Chainable

processedDate()

processedDate() : null|\DateTimeInterface

Retrieve the date/time the item was processed at.

Returns

null|\DateTimeInterface

preSaveQueueItem()

preSaveQueueItem() : \Charcoal\Queue\QueueItemInterface

Hook called before saving the item.

Presets the item as to-be processed and queued now.

Returns

\Charcoal\Queue\QueueItemInterface —

Chainable