Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Queue;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines a batch queue handler used by the Batch API.
Chris@0:  *
Chris@0:  * This implementation:
Chris@0:  * - Ensures FIFO ordering.
Chris@0:  * - Allows an item to be repeatedly claimed until it is actually deleted (no
Chris@0:  *   notion of lease time or 'expire' date), to allow multipass operations.
Chris@0:  *
Chris@0:  * Stale items from failed batches are cleaned from the {queue} table on cron
Chris@0:  * using the 'created' date.
Chris@0:  *
Chris@0:  * @ingroup queue
Chris@0:  */
Chris@0: class Batch extends DatabaseQueue {
Chris@0: 
Chris@0:   /**
Chris@0:    * Overrides \Drupal\Core\Queue\DatabaseQueue::claimItem().
Chris@0:    *
Chris@0:    * Unlike \Drupal\Core\Queue\DatabaseQueue::claimItem(), this method provides
Chris@0:    * a default lease time of 0 (no expiration) instead of 30. This allows the
Chris@0:    * item to be claimed repeatedly until it is deleted.
Chris@0:    */
Chris@0:   public function claimItem($lease_time = 0) {
Chris@0:     try {
Chris@0:       $item = $this->connection->queryRange('SELECT data, item_id FROM {queue} q WHERE name = :name ORDER BY item_id ASC', 0, 1, [':name' => $this->name])->fetchObject();
Chris@0:       if ($item) {
Chris@0:         $item->data = unserialize($item->data);
Chris@0:         return $item;
Chris@0:       }
Chris@0:     }
Chris@0:     catch (\Exception $e) {
Chris@0:       $this->catchException($e);
Chris@0:     }
Chris@0:     return FALSE;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Retrieves all remaining items in the queue.
Chris@0:    *
Chris@0:    * This is specific to Batch API and is not part of the
Chris@0:    * \Drupal\Core\Queue\QueueInterface.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   An array of queue items.
Chris@0:    */
Chris@0:   public function getAllItems() {
Chris@0:     $result = [];
Chris@0:     try {
Chris@0:       $items = $this->connection->query('SELECT data FROM {queue} q WHERE name = :name ORDER BY item_id ASC', [':name' => $this->name])->fetchAll();
Chris@0:       foreach ($items as $item) {
Chris@0:         $result[] = unserialize($item->data);
Chris@0:       }
Chris@0:     }
Chris@0:     catch (\Exception $e) {
Chris@0:       $this->catchException($e);
Chris@0:     }
Chris@0:     return $result;
Chris@0:   }
Chris@0: 
Chris@0: }