class BatchQueue

  1. cis7 includes/ BatchQueue
  2. cle7 includes/ BatchQueue
  3. elmsmedia7 includes/ BatchQueue
  4. icor7 includes/ BatchQueue
  5. meedjum_blog7 includes/ BatchQueue
  6. mooc7 includes/ BatchQueue

Defines a batch queue.

Stale items from failed batches are cleaned from the {queue} table on cron using the 'created' date.


Expanded class hierarchy of BatchQueue


Contains filters are case sensitive
Namesort descending Modifiers Type Description
BatchQueue::claimItem public function Overrides SystemQueue::claimItem().
BatchQueue::getAllItems public function Retrieves all remaining items in the queue.
SystemQueue::$name protected property The name of the queue this instance is working with.
SystemQueue::createItem public function Add a queue item and store it directly to the queue. Overrides DrupalQueueInterface::createItem
SystemQueue::createQueue public function Create a queue. Overrides DrupalQueueInterface::createQueue
SystemQueue::deleteItem public function Delete a finished item from the queue. Overrides DrupalQueueInterface::deleteItem
SystemQueue::deleteQueue public function Delete a queue and every item in the queue. Overrides DrupalQueueInterface::deleteQueue
SystemQueue::numberOfItems public function Retrieve the number of items in the queue. Overrides DrupalQueueInterface::numberOfItems
SystemQueue::releaseItem public function Release an item that the worker could not process, so another worker can come in and process it before the timeout expires. Overrides DrupalQueueInterface::releaseItem
SystemQueue::__construct public function


includes/, line 19
Queue handlers used by the Batch API.

View source
class BatchQueue extends SystemQueue {

   * Overrides SystemQueue::claimItem().
   * Unlike SystemQueue::claimItem(), this method provides a default lease
   * time of 0 (no expiration) instead of 30. This allows the item to be
   * claimed repeatedly until it is deleted.
  public function claimItem($lease_time = 0) {
    $item = db_query_range('SELECT data, item_id FROM {queue} q WHERE name = :name ORDER BY item_id ASC', 0, 1, array(':name' => $this->name))->fetchObject();
    if ($item) {
      $item->data = unserialize($item->data);
      return $item;
    return FALSE;

   * Retrieves all remaining items in the queue.
   * This is specific to Batch API and is not part of the DrupalQueueInterface.
  public function getAllItems() {
    $result = array();
    $items = db_query('SELECT data FROM {queue} q WHERE name = :name ORDER BY item_id ASC', array(':name' => $this->name))->fetchAll();
    foreach ($items as $item) {
      $result[] = unserialize($item->data);
    return $result;
2 string references to 'BatchQueue'
og-7.x-1.x.database.php in sites/all/modules/ulmus/og/tests/og-7.x-1.x.database.php
Filled installation of Drupal 7.0, for test purposes.
_batch_populate_queue in includes/
Populates a job queue with the operations of a batch set.



Error message

  • Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/elmsln_community/ in drupal_send_headers() (line 1499 of /var/www/html/elmsln_community/
  • Error: Call to undefined function apc_delete() in DrupalAPCCache->clear() (line 289 of /var/www/html/elmsln_community/
The website encountered an unexpected error. Please try again later.