Overview

Namespaces

  • Charcoal
    • Queue

Classes

  • AbstractQueueManager

Interfaces

  • QueueableInterface
  • QueueItemInterface
  • QueueManagerInterface

Traits

  • QueueableTrait
  • QueueItemTrait
  • Overview
  • Namespace
  • Class

Trait QueueItemTrait

Namespace: Charcoal\Queue
Located at Charcoal/Queue/QueueItemTrait.php
Methods summary
abstract public boolean
# process( callable $callback = null, callable $successCallback = null, callable $failureCallback = null )

Process the item.

Process the item.

Parameters

$callback
An optional callback routine executed after the item is processed.
$successCallback
An optional callback routine executed when the item is resolved.
$failureCallback
An optional callback routine executed when the item is rejected.

Returns

boolean
Success / Failure
public Charcoal\Queue\QueueItemTrait
# setQueueItemData( array $data )

Set the queue item's data.

Set the queue item's data.

Parameters

$data
The queue item data to set.

Returns

Charcoal\Queue\QueueItemTrait
Chainable
public Charcoal\Queue\QueueItemInterface
# setQueueId( mixed $id )

Set the queue's ID.

Set the queue's ID.

Parameters

$id
The unique queue identifier.

Returns

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

Get the queue's ID.

Get the queue's ID.

Returns

mixed
public Charcoal\Queue\QueueItemInterface
# setProcessed( boolean $processed )

Set the item's processed status.

Set the item's processed status.

Parameters

$processed
Whether the item has been processed.

Returns

Charcoal\Queue\QueueItemInterface
Chainable
public boolean
# processed( )

Determine if the item has been processed.

Determine if the item has been processed.

Returns

boolean
public Charcoal\Queue\QueueItemInterface
# setQueuedDate( null|string|DateTimeInterface $ts )

Set the date/time the item was queued at.

Set the date/time the item was queued at.

Parameters

$ts
A date/time string or object.

Returns

Charcoal\Queue\QueueItemInterface
Chainable

Throws

InvalidArgumentException
If the date/time is invalid.
public null|DateTimeInterface
# queuedDate( )

Retrieve the date/time the item was queued at.

Retrieve the date/time the item was queued at.

Returns

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

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

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

Parameters

$ts
A date/time string or object.

Returns

Charcoal\Queue\QueueItemInterface
Chainable

Throws

InvalidArgumentException
If the date/time is invalid.
public null|DateTimeInterface
# processingDate( )

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

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

Returns

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

Set the date/time the item was processed at.

Set the date/time the item was processed at.

Parameters

$ts
A date/time string or object.

Returns

Charcoal\Queue\QueueItemInterface
Chainable

Throws

InvalidArgumentException
If the date/time is invalid.
public null|DateTimeInterface
# processedDate( )

Retrieve the date/time the item was processed at.

Retrieve the date/time the item was processed at.

Returns

null|DateTimeInterface
public Charcoal\Queue\QueueItemInterface
# preSaveQueueItem( )

Hook called before saving the item.

Hook called before saving the item.

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

Returns

Charcoal\Queue\QueueItemInterface
Chainable
API documentation generated by ApiGen