Overview

Namespaces

  • Charcoal
    • Queue

Classes

  • Charcoal\Queue\AbstractQueueManager

Interfaces

  • Charcoal\Queue\QueueableInterface
  • Charcoal\Queue\QueueItemInterface
  • Charcoal\Queue\QueueManagerInterface

Traits

  • Charcoal\Queue\QueueableTrait
  • Charcoal\Queue\QueueItemTrait
  • Overview
  • Namespace
  • Class
 1: <?php
 2: 
 3: namespace Charcoal\Queue;
 4: 
 5: /**
 6:  * Queuable objects can be queued.
 7:  */
 8: interface QueueableInterface
 9: {
10:     /**
11:      * Set the queue's ID.
12:      *
13:      * @param mixed $id The unique queue identifier.
14:      * @return QueueableInterface Chainable
15:      */
16:     public function setQueueId($id);
17: 
18:     /**
19:      * Get the queue's ID.
20:      *
21:      * @return string $queueId
22:      */
23:     public function queueId();
24: 
25:     /**
26:      * Set the date/time to process the queue.
27:      *
28:      * @param mixed $ts A date/time to initiate the queue processing.
29:      * @return QueueableInterface Chainable
30:      */
31:     public function queue($ts = null);
32: }
33: 
API documentation generated by ApiGen