QueueDatabaseFactory.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Queue/QueueDatabaseFactory.php
  2. 10 core/lib/Drupal/Core/Queue/QueueDatabaseFactory.php
  3. 11.x core/lib/Drupal/Core/Queue/QueueDatabaseFactory.php

Namespace

Drupal\Core\Queue

File

core/lib/Drupal/Core/Queue/QueueDatabaseFactory.php

View source
<?php

namespace Drupal\Core\Queue;

use Drupal\Core\Database\Connection;

/**
 * Defines the key/value store factory for the database backend.
 */
class QueueDatabaseFactory {
    
    /**
     * The database connection.
     *
     * @var \Drupal\Core\Database\Connection
     */
    protected $connection;
    
    /**
     * Constructs this factory object.
     *
     * @param \Drupal\Core\Database\Connection $connection
     *   The Connection object containing the key-value tables.
     */
    public function __construct(Connection $connection) {
        $this->connection = $connection;
    }
    
    /**
     * Constructs a new queue object for a given name.
     *
     * @param string $name
     *   The name of the collection holding key and value pairs.
     *
     * @return \Drupal\Core\Queue\DatabaseQueue
     *   A key/value store implementation for the given $collection.
     */
    public function get($name) {
        return new DatabaseQueue($name, $this->connection);
    }

}

Classes

Title Deprecated Summary
QueueDatabaseFactory Defines the key/value store factory for the database backend.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.