class QueueWorkerManager
Defines the queue worker manager.
Hierarchy
- class \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\Component\Plugin\PluginManagerInterface, \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait, \Drupal\Core\Cache\UseCacheBackendTrait extends \Drupal\Component\Plugin\PluginManagerBase
- class \Drupal\Core\Queue\QueueWorkerManager implements \Drupal\Core\Queue\QueueWorkerManagerInterface extends \Drupal\Core\Plugin\DefaultPluginManager
 
 
 - class \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\Component\Plugin\PluginManagerInterface, \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait, \Drupal\Core\Cache\UseCacheBackendTrait extends \Drupal\Component\Plugin\PluginManagerBase
 
Expanded class hierarchy of QueueWorkerManager
See also
\Drupal\Core\Queue\QueueWorkerInterface
\Drupal\Core\Queue\QueueWorkerBase
\Drupal\Core\Annotation\QueueWorker
1 string reference to 'QueueWorkerManager'
- core.services.yml in core/
core.services.yml  - core/core.services.yml
 
1 service uses QueueWorkerManager
File
- 
              core/
lib/ Drupal/ Core/ Queue/ QueueWorkerManager.php, line 17  
Namespace
Drupal\Core\QueueView source
class QueueWorkerManager extends DefaultPluginManager implements QueueWorkerManagerInterface {
  
  /**
   * Constructs an 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);
    // Assign a default time if a cron is specified.
    if (isset($definition['cron'])) {
      $definition['cron'] += [
        'time' => 15,
      ];
    }
  }
  
  /**
   * {@inheritdoc}
   *
   * @return \Drupal\Core\Queue\QueueWorkerInterface
   */
  public function createInstance($plugin_id, array $configuration = []) {
    return parent::createInstance($plugin_id, $configuration);
  }
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| DefaultPluginManager::$additionalAnnotationNamespaces | protected | property | Additional namespaces the annotation discovery mechanism should scan for annotation definitions.  | 
                            ||
| DefaultPluginManager::$alterHook | protected | property | Name of the alter hook if one should be invoked. | ||
| DefaultPluginManager::$cacheKey | protected | property | The cache key. | ||
| DefaultPluginManager::$cacheTags | protected | property | An array of cache tags to use for the cached definitions. | ||
| DefaultPluginManager::$defaults | protected | property | A set of defaults to be referenced by $this->processDefinition() if additional processing of plugins is necessary or helpful for development purposes.  | 
                            9 | |
| DefaultPluginManager::$moduleHandler | protected | property | The module handler to invoke the alter hook. | 1 | |
| DefaultPluginManager::$namespaces | protected | property | An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.  | 
                            ||
| DefaultPluginManager::$pluginDefinitionAnnotationName | protected | property | The name of the annotation that contains the plugin definition. | ||
| DefaultPluginManager::$pluginInterface | protected | property | The interface each plugin should implement. | 1 | |
| DefaultPluginManager::$subdir | protected | property | The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace.  | 
                            ||
| DefaultPluginManager::alterDefinitions | protected | function | Invokes the hook to alter the definitions if the alter hook is set. | 1 | |
| DefaultPluginManager::alterInfo | protected | function | Sets the alter hook name. | ||
| DefaultPluginManager::clearCachedDefinitions | public | function | Clears static and persistent plugin definition caches. | Overrides CachedDiscoveryInterface::clearCachedDefinitions | 5 | 
| DefaultPluginManager::extractProviderFromDefinition | protected | function | Extracts the provider from a plugin definition. | ||
| DefaultPluginManager::findDefinitions | protected | function | Finds plugin definitions. | 7 | |
| DefaultPluginManager::fixContextAwareDefinitions | private | function | Fix the definitions of context-aware plugins. | ||
| DefaultPluginManager::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyInterface::getCacheContexts | |
| DefaultPluginManager::getCachedDefinitions | protected | function | Returns the cached plugin definitions of the decorated discovery class. | ||
| DefaultPluginManager::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyInterface::getCacheMaxAge | |
| DefaultPluginManager::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyInterface::getCacheTags | |
| DefaultPluginManager::getDefinitions | public | function | Gets the definition of all plugins for this type. | Overrides DiscoveryTrait::getDefinitions | 2 | 
| DefaultPluginManager::getDiscovery | protected | function | Gets the plugin discovery. | Overrides PluginManagerBase::getDiscovery | 12 | 
| DefaultPluginManager::getFactory | protected | function | Gets the plugin factory. | Overrides PluginManagerBase::getFactory | |
| DefaultPluginManager::providerExists | protected | function | Determines if the provider of a definition exists. | 3 | |
| DefaultPluginManager::setCacheBackend | public | function | Initialize the cache backend. | ||
| DefaultPluginManager::setCachedDefinitions | protected | function | Sets a cache of plugin definitions for the decorated discovery class. | ||
| DefaultPluginManager::useCaches | public | function | Disable the use of caches. | Overrides CachedDiscoveryInterface::useCaches | 1 | 
| DiscoveryCachedTrait::$definitions | protected | property | Cached definitions array. | 1 | |
| DiscoveryCachedTrait::getDefinition | public | function | Overrides DiscoveryTrait::getDefinition | 3 | |
| DiscoveryTrait::doGetDefinition | protected | function | Gets a specific plugin definition. | ||
| DiscoveryTrait::hasDefinition | public | function | |||
| PluginManagerBase::$discovery | protected | property | The object that discovers plugins managed by this manager. | ||
| PluginManagerBase::$factory | protected | property | The object that instantiates plugins managed by this manager. | ||
| PluginManagerBase::$mapper | protected | property | The object that returns the preconfigured plugin instance appropriate for a particular runtime condition. | ||
| PluginManagerBase::getInstance | public | function | Gets a preconfigured instance of a plugin. | Overrides MapperInterface::getInstance | 7 | 
| PluginManagerBase::handlePluginNotFound | protected | function | Allows plugin managers to specify custom behavior if a plugin is not found. | 1 | |
| QueueWorkerManager::createInstance | public | function | Overrides PluginManagerBase::createInstance | ||
| QueueWorkerManager::processDefinition | public | function | Performs extra processing on plugin definitions. | Overrides DefaultPluginManager::processDefinition | |
| QueueWorkerManager::__construct | public | function | Constructs an QueueWorkerManager object. | Overrides DefaultPluginManager::__construct | |
| UseCacheBackendTrait::$cacheBackend | protected | property | Cache backend instance. | ||
| UseCacheBackendTrait::$useCaches | protected | property | Flag whether caches should be used or skipped. | ||
| UseCacheBackendTrait::cacheGet | protected | function | Fetches from the cache backend, respecting the use caches flag. | 1 | |
| UseCacheBackendTrait::cacheSet | protected | function | Stores data in the persistent cache, respecting the use caches flag. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.