Error message

You are browsing documentation for drupal 7.x, which is not supported anymore. Read the updated version of this page for drupal 11.x (the latest version).

function BatchMemoryQueue::claimItem

Overrides MemoryQueue::claimItem().

Unlike MemoryQueue::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.

Overrides MemoryQueue::claimItem

File

includes/batch.queue.inc, line 64

Class

BatchMemoryQueue
Defines a batch queue for non-progressive batches.

Code

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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.