class DatabaseQueue in Queue UI 8.2

Defines the default Drupal Queue UI backend

Plugin annotation

@QueueUI(
  id = "database_queue",
  class_name = "DatabaseQueue"
)

Hierarchy

• class \Drupal\queue_ui\QueueUIBase implements QueueUIInterface
  • class \Drupal\queue_ui\Plugin\QueueUI\DatabaseQueue implements ContainerFactoryPluginInterface uses StringTranslationTrait

File

src/Plugin/QueueUI/DatabaseQueue.php, line 19

Namespace

Drupal\queue_ui\Plugin\QueueUI

class DatabaseQueue extends QueueUIBase implements ContainerFactoryPluginInterface {
  use StringTranslationTrait;

  /**
   * @var \Drupal\Core\Database\Database
   */
  private $database;

  /**
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   * @param array $configuration
   * @param string $plugin_id
   * @param mixed $plugin_definition
   *
   * @return \Drupal\Core\Plugin\ContainerFactoryPluginInterface|\Drupal\queue_ui\Plugin\QueueUI\DatabaseQueue
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('database'));
  }

  /**
   * DatabaseQueue constructor.
   *
   * @param array $configuration
   * @param $plugin_id
   * @param $plugin_definition
   * @param \Drupal\Core\Database\Connection $database
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Connection $database) {
    $this->database = $database;
  }

  /**
   * SystemQueue implements all default QueueUI methods.
   *
   * @return array
   *  An array of available QueueUI methods. Array key is system name of the
   *  operation, array key value is the display name.
   */
  public function getOperations() {
    return [
      'view' => $this
        ->t('View'),
      'release' => $this
        ->t('Release'),
      'delete' => $this
        ->t('Delete'),
    ];
  }

  /**
   * @param $queue_name
   *
   * @return mixed
   */
  public function getItems($queue_name) {
    $query = $this->database
      ->select('queue', 'q');
    $query
      ->addField('q', 'item_id');
    $query
      ->addField('q', 'expire');
    $query
      ->addField('q', 'created');
    $query
      ->condition('q.name', $queue_name);
    $query = $query
      ->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender');
    $query = $query
      ->limit(25);
    return $query
      ->execute();
  }

  /**
   * @param $queue_name
   *
   * @return \Drupal\Core\Database\StatementInterface|int|null
   */
  public function releaseItems($queue_name) {
    return $this->database
      ->update('queue')
      ->fields([
      'expire' => 0,
    ])
      ->condition('name', $queue_name, '=')
      ->execute();
  }

  /**
   * Load a specified SystemQueue queue item from the database.
   *
   * @param int $item_id
   * The item id to load
   *
   * @return mixed
   * Result of the database query loading the queue item.
   */
  public function loadItem($item_id) {

    // Load the specified queue item from the queue table.
    $query = $this->database
      ->select('queue', 'q')
      ->fields('q', [
      'item_id',
      'name',
      'data',
      'expire',
      'created',
    ])
      ->condition('q.item_id', $item_id)
      ->range(0, 1);

    // item id should be unique
    return $query
      ->execute()
      ->fetchObject();
  }

  /**
   * @param int $item_id
   */
  public function releaseItem($item_id) {
    $this->database
      ->update('queue')
      ->condition('item_id', $item_id)
      ->fields([
      'expire' => 0,
    ])
      ->execute();
  }

  /**
   * @param int $item_id
   */
  public function deleteItem($item_id) {
    $this->database
      ->delete('queue')
      ->condition('item_id', $item_id)
      ->execute();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DatabaseQueue::$database	private	property
DatabaseQueue::create	public static	function	Overrides ContainerFactoryPluginInterface::create
DatabaseQueue::deleteItem	public	function	Overrides QueueUIBase::deleteItem
DatabaseQueue::getItems	public	function	Overrides QueueUIBase::getItems
DatabaseQueue::getOperations	public	function	SystemQueue implements all default QueueUI methods. Overrides QueueUIBase::getOperations
DatabaseQueue::loadItem	public	function	Load a specified SystemQueue queue item from the database. Overrides QueueUIBase::loadItem
DatabaseQueue::releaseItem	public	function	Overrides QueueUIBase::releaseItem
DatabaseQueue::releaseItems	public	function	Overrides QueueUIBase::releaseItems
DatabaseQueue::__construct	public	function	DatabaseQueue constructor.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.