class QueueFactory

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Queue/QueueFactory.php \Drupal\Core\Queue\QueueFactory
  2. 10 core/lib/Drupal/Core/Queue/QueueFactory.php \Drupal\Core\Queue\QueueFactory
  3. 11.x core/lib/Drupal/Core/Queue/QueueFactory.php \Drupal\Core\Queue\QueueFactory

Defines the queue factory.

Hierarchy

  • class \Drupal\Core\Queue\QueueFactory implements \Symfony\Component\DependencyInjection\ContainerAwareInterface uses \Symfony\Component\DependencyInjection\ContainerAwareTrait

Expanded class hierarchy of QueueFactory

2 files declare their use of QueueFactory
Cron.php in core/lib/Drupal/Core/Cron.php
UpdateProcessor.php in core/modules/update/src/UpdateProcessor.php
1 string reference to 'QueueFactory'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses QueueFactory
queue in core/core.services.yml
Drupal\Core\Queue\QueueFactory

File

core/lib/Drupal/Core/Queue/QueueFactory.php, line 12

Namespace

Drupal\Core\Queue
View source 
class QueueFactory implements ContainerAwareInterface {
    use ContainerAwareTrait;
    
    /**
     * Instantiated queues, keyed by name.
     *
     * @var array
     */
    protected $queues = [];
    
    /**
     * The settings object.
     *
     * @var \Drupal\Core\Site\Settings
     */
    protected $settings;
    
    /**
     * Constructs a queue factory.
     */
    public function __construct(Settings $settings) {
        $this->settings = $settings;
    }
    
    /**
     * Constructs a new queue.
     *
     * @param string $name
     *   The name of the queue to work with.
     * @param bool $reliable
     *   (optional) TRUE if the ordering of items and guaranteeing every item executes at
     *   least once is important, FALSE if scalability is the main concern. Defaults
     *   to FALSE.
     *
     * @return \Drupal\Core\Queue\QueueInterface
     *   A queue implementation for the given name.
     */
    public function get($name, $reliable = FALSE) {
        if (!isset($this->queues[$name])) {
            // If it is a reliable queue, check the specific settings first.
            if ($reliable) {
                $service_name = $this->settings
                    ->get('queue_reliable_service_' . $name);
            }
            // If no reliable queue was defined, check the service and global
            // settings, fall back to queue.database.
            if (empty($service_name)) {
                $service_name = $this->settings
                    ->get('queue_service_' . $name, $this->settings
                    ->get('queue_default', 'queue.database'));
            }
            $this->queues[$name] = $this->container
                ->get($service_name)
                ->get($name);
        }
        return $this->queues[$name];
    }

}

Members

Title Modifiers Object type Summary
QueueFactory::$queues protected property Instantiated queues, keyed by name.
QueueFactory::$settings protected property The settings object.
QueueFactory::get public function Constructs a new queue.
QueueFactory::__construct public function Constructs a queue factory.

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