You are here

Home » API reference » More Global Variables 8 » MgvPluginManager.php

class MgvPluginManager in More Global Variables 8

Class MgvPluginManager.

@package Drupal\mgv\Annotation

Hierarchy

Expanded class hierarchy of MgvPluginManager

1 string reference to 'MgvPluginManager'
mgv.services.yml in ./mgv.services.yml
mgv.services.yml
1 service uses MgvPluginManager
plugin.manager.mgv in ./mgv.services.yml
Drupal\mgv\MgvPluginManager

File

src/MgvPluginManager.php, line 19

Namespace

Drupal\mgv
View source 
class MgvPluginManager extends DefaultPluginManager implements MgvPluginManagerInterface {

  /**
   * Variables list.
   *
   * @var array
   */
  private $variables = [];

  /**
   * Constructs GlobalVariablePluginManager.
   *
   * @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 to invoke the alter hook with.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin' . DIRECTORY_SEPARATOR . 'GlobalVariable', $namespaces, $module_handler, 'Drupal\\mgv\\Plugin\\GlobalVariableInterface', 'Drupal\\mgv\\Annotation\\Mgv');
    $this
      ->setCacheBackend($cache_backend, 'mgv');
    $this->factory = new DefaultFactory($this
      ->getDiscovery());
  }

  /**
   * {@inheritdoc}
   */
  public function getVariables() {
    if (empty($this->variables)) {
      $this->variables = [];
      $all = $this
        ->getDefinitions();
      foreach ($all as $definition_info) {

        /* @var \Drupal\mgv\Plugin\GlobalVariableInterface $variable */
        $variable = $this
          ->createInstance($definition_info['id'], $definition_info);
        $this->variables = NestedArray::mergeDeep($this->variables, $this
          ->getNamespacedValue($definition_info['id'], $variable));
      }
    }
    return $this->variables;
  }

  /**
   * {@inheritdoc}
   */
  public function getNamespacedValue($plugin_id, GlobalVariableInterface $variable) {
    $value = $variable
      ->getValue();
    $namespaces = explode('\\', $plugin_id);
    foreach (array_reverse($namespaces) as $name) {
      $value = [
        $name => $value,
      ];
    }
    return $value;
  }

  /**
   * {@inheritdoc}
   */
  public function createInstance($plugin_id, array $configuration = []) {
    if (!empty($configuration['variableDependencies'])) {
      foreach ($configuration['variableDependencies'] as $key => $plugin) {
        $definition = $this
          ->getDefinition($plugin);

        /* @var \Drupal\mgv\Plugin\GlobalVariableInterface $instance */
        $instance = $this
          ->createInstance($definition['id'], $definition);
        $configuration['variableDependencies'][$plugin] = $instance
          ->getValue();
        unset($configuration['variableDependencies'][$key]);
      }
    }
    return parent::createInstance($plugin_id, $configuration);
  }

}

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::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
MgvPluginManager::$variables private property Variables list.
MgvPluginManager::createInstance public function Creates a pre-configured instance of a plugin. Overrides PluginManagerBase::createInstance
MgvPluginManager::getNamespacedValue public function Create namespaced value of given global variable id and instance. Overrides MgvPluginManagerInterface::getNamespacedValue
MgvPluginManager::getVariables public function Returns all the variables. Overrides MgvPluginManagerInterface::getVariables
MgvPluginManager::__construct public function Constructs GlobalVariablePluginManager. 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::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.