You are here

Home » API reference » Feeds 8.3 » FeedsPluginManager.php

class FeedsPluginManager in Feeds 8.3

Manages Feeds plugins.

Hierarchy

Expanded class hierarchy of FeedsPluginManager

1 file declares its use of FeedsPluginManager
FeedTypeTest.php in tests/src/Unit/Entity/FeedTypeTest.php
1 string reference to 'FeedsPluginManager'
feeds.services.yml in ./feeds.services.yml
feeds.services.yml
5 services use FeedsPluginManager
plugin.manager.feeds.fetcher in ./feeds.services.yml
Drupal\feeds\Plugin\Type\FeedsPluginManager
plugin.manager.feeds.parser in ./feeds.services.yml
Drupal\feeds\Plugin\Type\FeedsPluginManager
plugin.manager.feeds.processor in ./feeds.services.yml
Drupal\feeds\Plugin\Type\FeedsPluginManager
plugin.manager.feeds.source in ./feeds.services.yml
Drupal\feeds\Plugin\Type\FeedsPluginManager
plugin.manager.feeds.target in ./feeds.services.yml
Drupal\feeds\Plugin\Type\FeedsPluginManager

File

src/Plugin/Type/FeedsPluginManager.php, line 16

Namespace

Drupal\feeds\Plugin\Type
View source 
class FeedsPluginManager extends DefaultPluginManager {

  /**
   * The plugin being managed.
   *
   * @var string
   */
  protected $pluginType;

  /**
   * Constructs a new \Drupal\feeds\Plugin\Type\FeedsPluginManager object.
   *
   * @param string $type
   *   The plugin type. Either fetcher, parser, or processor, handler, source,
   *   target, or other.
   * @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\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler to invoke the alter hook with.
   */
  public function __construct($type, \Traversable $namespaces, CacheBackendInterface $cache_backend, LanguageManagerInterface $language_manager, ModuleHandlerInterface $module_handler) {
    $type_annotations = [
      'fetcher' => 'Drupal\\feeds\\Annotation\\FeedsFetcher',
      'parser' => 'Drupal\\feeds\\Annotation\\FeedsParser',
      'processor' => 'Drupal\\feeds\\Annotation\\FeedsProcessor',
      'source' => 'Drupal\\feeds\\Annotation\\FeedsSource',
      'target' => 'Drupal\\feeds\\Annotation\\FeedsTarget',
    ];
    $plugin_interfaces = [
      'fetcher' => 'Drupal\\feeds\\Plugin\\Type\\Fetcher\\FetcherInterface',
      'parser' => 'Drupal\\feeds\\Plugin\\Type\\Parser\\ParserInterface',
      'processor' => 'Drupal\\feeds\\Plugin\\Type\\Processor\\ProcessorInterface',
      'source' => 'Drupal\\feeds\\Plugin\\Type\\Source\\SourceInterface',
      'target' => 'Drupal\\feeds\\Plugin\\Type\\Target\\TargetInterface',
    ];
    $this->pluginType = $type;
    $this->subdir = 'Feeds/' . ucfirst($type);
    $this->discovery = new AnnotatedClassDiscovery($this->subdir, $namespaces, $type_annotations[$type]);
    $this->discovery = new OverridableDerivativeDiscoveryDecorator($this->discovery);
    $this->factory = new FeedsAnnotationFactory($this, $plugin_interfaces[$type]);
    $this->moduleHandler = $module_handler;
    $this
      ->alterInfo("feeds_{$type}_plugins");
    $this
      ->setCacheBackend($cache_backend, "feeds_{$type}_plugins");
  }

  /**
   * {@inheritdoc}
   */
  public function processDefinition(&$definition, $plugin_id) {
    parent::processDefinition($definition, $plugin_id);

    // Add plugin_type key so that we can determine the plugin type later.
    $definition['plugin_type'] = $this->pluginType;

    // If no default form is defined and this plugin implements
    // \Drupal\Core\Plugin\PluginFormInterface, use that for the default form.
    if (!isset($definition['form']['configuration']) && isset($definition['class']) && is_subclass_of($definition['class'], PluginFormInterface::class)) {
      $definition['form']['configuration'] = $definition['class'];
    }
  }

}

Members

Namesort descending Modifiers Type Description 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
FeedsPluginManager::$pluginType protected property The plugin being managed.
FeedsPluginManager::processDefinition public function Performs extra processing on plugin definitions. Overrides DefaultPluginManager::processDefinition
FeedsPluginManager::__construct public function Constructs a new \Drupal\feeds\Plugin\Type\FeedsPluginManager object. Overrides DefaultPluginManager::__construct
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 7
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. 1
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.