summaryrefslogtreecommitdiffstats
path: root/core/lib/Drupal/Core/Queue/BatchMemory.php
diff options
context:
space:
mode:
Diffstat (limited to 'core/lib/Drupal/Core/Queue/BatchMemory.php')
-rw-r--r--core/lib/Drupal/Core/Queue/BatchMemory.php52
1 files changed, 52 insertions, 0 deletions
diff --git a/core/lib/Drupal/Core/Queue/BatchMemory.php b/core/lib/Drupal/Core/Queue/BatchMemory.php
new file mode 100644
index 0000000..fcc49f5
--- /dev/null
+++ b/core/lib/Drupal/Core/Queue/BatchMemory.php
@@ -0,0 +1,52 @@
+<?php
+
+/**
+ * @file
+ * Definition of Drupal\Core\Queue\BatchMemory.
+ */
+
+namespace Drupal\Core\Queue;
+
+/**
+ * Defines a batch queue handler used by the Batch API for non-progressive
+ * batches.
+ *
+ * This implementation:
+ * - Ensures FIFO ordering.
+ * - Allows an item to be repeatedly claimed until it is actually deleted (no
+ * notion of lease time or 'expire' date), to allow multipass operations.
+ */
+class BatchMemory extends Memory {
+
+ /**
+ * 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.
+ */
+ 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
+ * Drupal\Core\Queue\QueueInterface.
+ *
+ * @return array
+ * An array of queue items.
+ */
+ public function getAllItems() {
+ $result = array();
+ foreach ($this->queue as $item) {
+ $result[] = $item->data;
+ }
+ return $result;
+ }
+}