Full ELMS Learning Network documentation
class BatchMemoryQueue
- cis7 includes/batch.queue.inc BatchMemoryQueue
- cle7 includes/batch.queue.inc BatchMemoryQueue
- elmsmedia7 includes/batch.queue.inc BatchMemoryQueue
- icor7 includes/batch.queue.inc BatchMemoryQueue
- meedjum_blog7 includes/batch.queue.inc BatchMemoryQueue
- mooc7 includes/batch.queue.inc BatchMemoryQueue
Defines a batch queue for non-progressive batches.
Hierarchy
- class BatchMemoryQueue
Expanded class hierarchy of BatchMemoryQueue
Members
Name |
Modifiers | Type | Description |
|---|---|---|---|
| BatchMemoryQueue::claimItem | public | function | Overrides MemoryQueue::claimItem(). |
| BatchMemoryQueue::getAllItems | public | function | Retrieves all remaining items in the queue. |
| MemoryQueue::$id_sequence | protected | property | Counter for item ids. |
| MemoryQueue::$queue | protected | property | The queue data. |
| MemoryQueue::createItem | public | function | Add a queue item and store it directly to the queue. Overrides DrupalQueueInterface::createItem |
| MemoryQueue::createQueue | public | function | Create a queue. Overrides DrupalQueueInterface::createQueue |
| MemoryQueue::deleteItem | public | function | Delete a finished item from the queue. Overrides DrupalQueueInterface::deleteItem |
| MemoryQueue::deleteQueue | public | function | Delete a queue and every item in the queue. Overrides DrupalQueueInterface::deleteQueue |
| MemoryQueue::numberOfItems | public | function | Retrieve the number of items in the queue. Overrides DrupalQueueInterface::numberOfItems |
| MemoryQueue::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 |
| MemoryQueue::__construct | public | function | Start working with a queue. |
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;
}
}
2 string references to 'BatchMemoryQueue'
- 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/
form.inc - Populates a job queue with the operations of a batch set.