Defines a batch queue for non-progressive batches.
Hierarchy
- MemoryQueue implements DrupalQueueInterface
Functions & methods
| Name | Description |
|---|---|
| BatchMemoryQueue::claimItem | Overrides MemoryQueue::claimItem(). Overrides MemoryQueue::claimItem |
| BatchMemoryQueue::getAllItems | Retrieves all remaining items in the queue. |
| MemoryQueue::createItem | Add a queue item and store it directly to the queue. Overrides DrupalQueueInterface::createItem |
| MemoryQueue::createQueue | Create a queue. Overrides DrupalQueueInterface::createQueue |
| MemoryQueue::deleteItem | Delete a finished item from the queue. Overrides DrupalQueueInterface::deleteItem |
| MemoryQueue::deleteQueue | Delete a queue and every item in the queue. Overrides DrupalQueueInterface::deleteQueue |
| MemoryQueue::numberOfItems | Retrieve the number of items in the queue. Overrides DrupalQueueInterface::numberOfItems |
| MemoryQueue::releaseItem | 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 |
| MemoryQueue::__construct | Start working with a queue. Overrides DrupalQueueInterface::__construct |
Properties
| Name | Description |
|---|---|
| MemoryQueue::$id_sequence | Counter for item ids. |
| MemoryQueue::$queue | The queue data. |
File
- includes/
batch.queue.inc, line 55 - Queue handlers used by the Batch API.
View source
class BatchMemoryQueue extends MemoryQueue {
/**
* 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.
*/
public function claimItem($lease_time = 0) {
if (!empty($this->queue)) {
reset($this->queue);
return current($this->queue);
}
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();
foreach ($this->queue as $item) {
$result[] = $item->data;
}
return $result;
}
}