\Charcoal\QueueQueueableTrait

Full implementation, as a Trait, of the `QueueableInterface`.

Summary

Methods
Properties
Constants
setQueueId()
queueId()
queue()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$queueId
N/A

Properties

$queueId

$queueId : mixed

The queue ID.

Type

mixed

Methods

setQueueId()

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

Set the queue's ID.

Parameters

mixed $id

The unique queue identifier.

Throws

\InvalidArgumentException

If the ID isn't a string.

Returns

\Charcoal\Queue\QueueableInterface

Chainable

queueId()

queueId() : string

Get the queue's ID.

Returns

string —

$queueId

queue()

queue(mixed  $ts = null) : mixed

Set the date/time to process the queue.

Parameters

mixed $ts

A date/time to initiate the queue processing.

Returns

mixed