Overview

Namespaces

  • Charcoal
    • Queue

Classes

  • AbstractQueueManager

Interfaces

  • QueueableInterface
  • QueueItemInterface
  • QueueManagerInterface

Traits

  • QueueableTrait
  • QueueItemTrait
  • Overview
  • Namespace
  • Class

Interface QueueManagerInterface

The queue manager is used to load queued items and batch-process them.

Direct known implementers

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

Set the queue's ID.

Set the queue's ID.

Parameters

$id
The unique queue identifier.

Returns

Charcoal\Queue\QueueManagerInterface
Chainable
public mixed
# queueId( )

Get the queue's ID.

Get the queue's ID.

Returns

mixed
public Charcoal\Queue\QueueManagerInterface
# setItemSuccessCallback( callable $callback )

Set the callback routine when the item is resolved.

Set the callback routine when the item is resolved.

Parameters

$callback
A item callback routine.

Returns

Charcoal\Queue\QueueManagerInterface
Chainable
public Charcoal\Queue\QueueManagerInterface
# setItemFailureCallback( callable $callback )

Set the callback routine when the item is rejected.

Set the callback routine when the item is rejected.

Parameters

$callback
A item callback routine.

Returns

Charcoal\Queue\QueueManagerInterface
Chainable
public Charcoal\Queue\QueueManagerInterface
# setProcessedCallback( callable $callback )

Set the callback routine when the queue is processed.

Set the callback routine when the queue is processed.

Parameters

$callback
A queue callback routine.

Returns

Charcoal\Queue\QueueManagerInterface
Chainable
public boolean
# processQueue( )

Process the items of the queue.

Process the items of the queue.

Returns

boolean
Success / Failure
public Collection
# loadQueueItems( )

Retrieve the items of the current queue.

Retrieve the items of the current queue.

Returns

Collection
public Charcoal\Queue\QueueItemInterface
# queueItemProto( )

Retrieve the queue item's model.

Retrieve the queue item's model.

Returns

Charcoal\Queue\QueueItemInterface
API documentation generated by ApiGen