public function BatchMemory::claimItem in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Queue/BatchMemory.php \Drupal\Core\Queue\BatchMemory::claimItem()
2. 10 core/lib/Drupal/Core/Queue/BatchMemory.php \Drupal\Core\Queue\BatchMemory::claimItem()

Overrides \Drupal\Core\Queue\Memory::claimItem().

Unlike \Drupal\Core\Queue\Memory::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 Memory::claimItem

File

core/lib/Drupal/Core/Queue/BatchMemory.php, line 25

Class

BatchMemory

Defines a batch queue handler used by the Batch API for non-progressive batches.

Namespace

Drupal\Core\Queue

Code

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