class Memory

Static queue implementation.

This allows "undelayed" variants of processes relying on the Queue interface. The queue data resides in memory. It should only be used for items that will be queued and dequeued within a given page request.

Hierarchy

Expanded class hierarchy of Memory

1 file declares its use of Memory
QueueTest.php in drupal/core/modules/system/lib/Drupal/system/Tests/Queue/QueueTest.php
Definition of Drupal\system\Tests\Queue\QueueTest.

File

drupal/core/lib/Drupal/Core/Queue/Memory.php, line 19
Definition of Drupal\Core\Queue\Memory.

Namespace

Drupal\Core\Queue
View source
class Memory implements QueueInterface {

  /**
   * The queue data.
   *
   * @var array
   */
  protected $queue;

  /**
   * Counter for item ids.
   *
   * @var int
   */
  protected $idSequence;

  /**
   * Constructs a Memory object.
   *
   * @param string $name
   *   An arbitrary string. The name of the queue to work with.
   */
  public function __construct($name) {
    $this->queue = array();
    $this->idSequence = 0;
  }

  /**
   * Implements Drupal\Core\Queue\QueueInterface::createItem().
   */
  public function createItem($data) {
    $item = new stdClass();
    $item->item_id = $this->idSequence++;
    $item->data = $data;
    $item->created = time();
    $item->expire = 0;
    $this->queue[$item->item_id] = $item;
    return $item->item_id;
  }

  /**
   * Implements Drupal\Core\Queue\QueueInterface::numberOfItems().
   */
  public function numberOfItems() {
    return count($this->queue);
  }

  /**
   * Implements Drupal\Core\Queue\QueueInterface::claimItem().
   */
  public function claimItem($lease_time = 30) {
    foreach ($this->queue as $key => $item) {
      if ($item->expire == 0) {
        $item->expire = time() + $lease_time;
        $this->queue[$key] = $item;
        return $item;
      }
    }
    return FALSE;
  }

  /**
   * Implements Drupal\Core\Queue\QueueInterface::deleteItem().
   */
  public function deleteItem($item) {
    unset($this->queue[$item->item_id]);
  }

  /**
   * Implements Drupal\Core\Queue\QueueInterface::releaseItem().
   */
  public function releaseItem($item) {
    if (isset($this->queue[$item->item_id]) && $this->queue[$item->item_id]->expire != 0) {
      $this->queue[$item->item_id]->expire = 0;
      return TRUE;
    }
    return FALSE;
  }

  /**
   * Implements Drupal\Core\Queue\QueueInterface::createQueue().
   */
  public function createQueue() {

    // Nothing needed here.
  }

  /**
   * Implements Drupal\Core\Queue\QueueInterface::deleteQueue().
   */
  public function deleteQueue() {
    $this->queue = array();
    $this->idSequence = 0;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Memory::$idSequence protected property Counter for item ids.
Memory::$queue protected property The queue data.
Memory::claimItem public function Implements Drupal\Core\Queue\QueueInterface::claimItem(). Overrides QueueInterface::claimItem 1
Memory::createItem public function Implements Drupal\Core\Queue\QueueInterface::createItem(). Overrides QueueInterface::createItem
Memory::createQueue public function Implements Drupal\Core\Queue\QueueInterface::createQueue(). Overrides QueueInterface::createQueue
Memory::deleteItem public function Implements Drupal\Core\Queue\QueueInterface::deleteItem(). Overrides QueueInterface::deleteItem
Memory::deleteQueue public function Implements Drupal\Core\Queue\QueueInterface::deleteQueue(). Overrides QueueInterface::deleteQueue
Memory::numberOfItems public function Implements Drupal\Core\Queue\QueueInterface::numberOfItems(). Overrides QueueInterface::numberOfItems
Memory::releaseItem public function Implements Drupal\Core\Queue\QueueInterface::releaseItem(). Overrides QueueInterface::releaseItem
Memory::__construct public function Constructs a Memory object.