Home › API reference › batch.queue.inc

BatchMemoryQueue

Batch queue implementation used for non-progressive batches.

Hierarchy

Functions & methods

NameDescription
BatchMemoryQueue::claimItemClaim an item in the queue for processing. Overrides MemoryQueue::claimItem
BatchMemoryQueue::getAllItemsRetrieve all remaining items in the queue.
MemoryQueue::createItemAdd a queue item and store it directly to the queue. Overrides DrupalQueueInterface::createItem
MemoryQueue::createQueueCreate a queue. Overrides DrupalQueueInterface::createQueue
MemoryQueue::deleteItemDelete a finished item from the queue. Overrides DrupalQueueInterface::deleteItem
MemoryQueue::deleteQueueDelete a queue and every item in the queue. Overrides DrupalQueueInterface::deleteQueue
MemoryQueue::numberOfItemsRetrieve the number of items in the queue. Overrides DrupalQueueInterface::numberOfItems
MemoryQueue::releaseItemRelease an item that the worker could not process, so another worker can come in and process it before the timeout expires. Overrides DrupalQueueInterface::releaseItem
MemoryQueue::__constructStart working with a queue. Overrides DrupalQueueInterface::__construct

Properties

NameDescription
MemoryQueue::$id_sequenceCounter for item ids.
MemoryQueue::$queueThe queue data.

drupal/includes/batch.queue.inc, line 50

View code
<?php
class BatchMemoryQueue extends MemoryQueue {

  public function claimItem($lease_time = 0) {
    if (!empty($this->queue)) {
      reset($this->queue);
      return current($this->queue);
    }
    return FALSE;
  }

  /**
   * Retrieve all remaining items in the queue.
   *
   * This is specific to Batch API and is not part of the DrupalQueueInterface,
   */
  public function getAllItems() {
    $result = array();
    foreach ($this->queue as $item) {
      $result[] = $item->data;
    }
    return $result;
  }
}
?>