You are here

class AggregatorPluginManager in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/aggregator/src/Plugin/AggregatorPluginManager.php \Drupal\aggregator\Plugin\AggregatorPluginManager

Manages aggregator plugins.

Hierarchy

Expanded class hierarchy of AggregatorPluginManager

See also

\Drupal\aggregator\Annotation\AggregatorParser

\Drupal\aggregator\Annotation\AggregatorFetcher

\Drupal\aggregator\Annotation\AggregatorProcessor

\Drupal\aggregator\Plugin\AggregatorPluginSettingsBase

\Drupal\aggregator\Plugin\FetcherInterface

\Drupal\aggregator\Plugin\ProcessorInterface

\Drupal\aggregator\Plugin\ParserInterface

Plugin API

2 files declare their use of AggregatorPluginManager
ItemsImporter.php in core/modules/aggregator/src/ItemsImporter.php
SettingsForm.php in core/modules/aggregator/src/Form/SettingsForm.php
1 string reference to 'AggregatorPluginManager'
aggregator.services.yml in core/modules/aggregator/aggregator.services.yml
core/modules/aggregator/aggregator.services.yml
3 services use AggregatorPluginManager
plugin.manager.aggregator.fetcher in core/modules/aggregator/aggregator.services.yml
Drupal\aggregator\Plugin\AggregatorPluginManager
plugin.manager.aggregator.parser in core/modules/aggregator/aggregator.services.yml
Drupal\aggregator\Plugin\AggregatorPluginManager
plugin.manager.aggregator.processor in core/modules/aggregator/aggregator.services.yml
Drupal\aggregator\Plugin\AggregatorPluginManager

File

core/modules/aggregator/src/Plugin/AggregatorPluginManager.php, line 21

Namespace

Drupal\aggregator\Plugin
View source
class AggregatorPluginManager extends DefaultPluginManager {

  /**
   * Constructs an AggregatorPluginManager object.
   *
   * @param string $type
   *   The plugin type, for example fetcher.
   * @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($type, \Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    $type_annotations = [
      'fetcher' => 'Drupal\\aggregator\\Annotation\\AggregatorFetcher',
      'parser' => 'Drupal\\aggregator\\Annotation\\AggregatorParser',
      'processor' => 'Drupal\\aggregator\\Annotation\\AggregatorProcessor',
    ];
    $plugin_interfaces = [
      'fetcher' => 'Drupal\\aggregator\\Plugin\\FetcherInterface',
      'parser' => 'Drupal\\aggregator\\Plugin\\ParserInterface',
      'processor' => 'Drupal\\aggregator\\Plugin\\ProcessorInterface',
    ];
    parent::__construct("Plugin/aggregator/{$type}", $namespaces, $module_handler, $plugin_interfaces[$type], $type_annotations[$type]);
    $this
      ->alterInfo('aggregator_' . $type . '_info');
    $this
      ->setCacheBackend($cache_backend, 'aggregator_' . $type . '_plugins');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AggregatorPluginManager::__construct public function Constructs an AggregatorPluginManager object. Overrides DefaultPluginManager::__construct
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 6
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
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::processDefinition public function Performs extra processing on plugin definitions. 13
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::createInstance public function Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance 12
PluginManagerBase::getInstance public function Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance 6
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
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.
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.