summaryrefslogtreecommitdiffstats
path: root/core/lib/Drupal/Core/Queue/Batch.php
diff options
context:
space:
mode:
Diffstat (limited to 'core/lib/Drupal/Core/Queue/Batch.php')
-rw-r--r--core/lib/Drupal/Core/Queue/Batch.php56
1 files changed, 56 insertions, 0 deletions
diff --git a/core/lib/Drupal/Core/Queue/Batch.php b/core/lib/Drupal/Core/Queue/Batch.php
new file mode 100644
index 0000000..a1de48a
--- /dev/null
+++ b/core/lib/Drupal/Core/Queue/Batch.php
@@ -0,0 +1,56 @@
+<?php
+
+/**
+ * @file
+ * Definition of Drupal\Core\Queue\Batch.
+ */
+
+namespace Drupal\Core\Queue;
+
+/**
+ * Defines a batch queue handler used by the Batch API.
+ *
+ * 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.
+ *
+ * Stale items from failed batches are cleaned from the {queue} table on cron
+ * using the 'created' date.
+ */
+class Batch extends System {
+
+ /**
+ * Overrides Drupal\Core\Queue\System::claimItem().
+ *
+ * Unlike Drupal\Core\Queue\System::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) {
+ $item = db_query_range('SELECT data, item_id FROM {queue} q WHERE name = :name ORDER BY item_id ASC', 0, 1, array(':name' => $this->name))->fetchObject();
+ if ($item) {
+ $item->data = unserialize($item->data);
+ return $item;
+ }
+ 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();
+ $items = db_query('SELECT data FROM {queue} q WHERE name = :name ORDER BY item_id ASC', array(':name' => $this->name))->fetchAll();
+ foreach ($items as $item) {
+ $result[] = unserialize($item->data);
+ }
+ return $result;
+ }
+}