Overview

Namespaces

  • Charcoal
    • Queue

Classes

  • AbstractQueueManager

Interfaces

  • QueueableInterface
  • QueueItemInterface
  • QueueManagerInterface

Traits

  • QueueableTrait
  • QueueItemTrait
  • Overview
  • Namespace
  • Class

Trait QueueableTrait

Full implementation, as a Trait, of the QueueableInterface.

Namespace: Charcoal\Queue
Located at Charcoal/Queue/QueueableTrait.php
Methods summary
public Charcoal\Queue\QueueableInterface
# setQueueId( mixed $id )

Set the queue's ID.

Set the queue's ID.

Parameters

$id
The unique queue identifier.

Returns

Charcoal\Queue\QueueableInterface
Chainable

Throws

InvalidArgumentException
If the ID isn't a string.
public string
# queueId( )

Get the queue's ID.

Get the queue's ID.

Returns

string
$queueId
abstract public mixed
# queue( mixed $ts = null )

Set the date/time to process the queue.

Set the date/time to process the queue.

Parameters

$ts
A date/time to initiate the queue processing.

Returns

mixed
API documentation generated by ApiGen