QueueWorkerManager.php

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

Namespace

Drupal\Core\Queue

File

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

View source
<?php

namespace Drupal\Core\Queue;

use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Plugin\DefaultPluginManager;

/**
 * Defines the queue worker manager.
 *
 * @see \Drupal\Core\Queue\QueueWorkerInterface
 * @see \Drupal\Core\Queue\QueueWorkerBase
 * @see \Drupal\Core\Annotation\QueueWorker
 * @see plugin_api
 */
class QueueWorkerManager extends DefaultPluginManager implements QueueWorkerManagerInterface {
    
    /**
     * Constructs a QueueWorkerManager object.
     *
     * @param \Traversable $namespaces
     *   An object that implements \Traversable which contains the root paths
     *   keyed by the corresponding namespace to look for plugin implementations.
     * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
     *   Cache backend instance to use.
     * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
     *   The module handler.
     */
    public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
        parent::__construct('Plugin/QueueWorker', $namespaces, $module_handler, 'Drupal\\Core\\Queue\\QueueWorkerInterface', 'Drupal\\Core\\Annotation\\QueueWorker');
        $this->setCacheBackend($cache_backend, 'queue_plugins');
        $this->alterInfo('queue_info');
    }
    
    /**
     * {@inheritdoc}
     */
    public function processDefinition(&$definition, $plugin_id) {
        parent::processDefinition($definition, $plugin_id);
        // Safeguard to ensure the default lease time is used in the case of a
        // malformed queue worker annotation where cron is specified without a time,
        // or an invalid time is provided.
        //
        // @see \Drupal\Core\Cron::processQueues()
        if (isset($definition['cron'])) {
            $time = $definition['cron']['time'] ?? 0;
            if ($time <= 0) {
                $definition['cron']['time'] = self::DEFAULT_QUEUE_CRON_TIME;
            }
        }
    }
    
    /**
     * {@inheritdoc}
     *
     * @return \Drupal\Core\Queue\QueueWorkerInterface
     */
    public function createInstance($plugin_id, array $configuration = []) {
        return parent::createInstance($plugin_id, $configuration);
    }

}

Classes

Title Deprecated Summary
QueueWorkerManager Defines the queue worker manager.

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