Defines a batch queue for non-progressive batches.
Expanded class hierarchy of BatchMemoryQueue
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;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BatchMemoryQueue:: |
public | function |
Overrides MemoryQueue::claimItem(). Overrides MemoryQueue:: |
|
BatchMemoryQueue:: |
public | function | Retrieves all remaining items in the queue. | |
MemoryQueue:: |
public | function | Start working with a queue. | |
MemoryQueue:: |
public | function |
Add a queue item and store it directly to the queue. Overrides DrupalQueueInterface:: |
|
MemoryQueue:: |
public | function |
Retrieve the number of items in the queue. Overrides DrupalQueueInterface:: |
|
MemoryQueue:: |
public | function |
Delete a finished item from the queue. Overrides DrupalQueueInterface:: |
|
MemoryQueue:: |
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:: |
|
MemoryQueue:: |
public | function |
Create a queue. Overrides DrupalQueueInterface:: |
|
MemoryQueue:: |
public | function |
Delete a queue and every item in the queue. Overrides DrupalQueueInterface:: |
|
MemoryQueue:: |
protected | property | The queue data. | |
MemoryQueue:: |
protected | property | Counter for item ids. |