You are here

Home » API reference » Entity Browser Enhance(d|r) 8 » EntityBrowserEnhancedPluginManager.php

class EntityBrowserEnhancedPluginManager in Entity Browser Enhance(d|r) 8

Provides the default entity_browser_enhanced_plugin manager.

Hierarchy

Expanded class hierarchy of EntityBrowserEnhancedPluginManager

1 string reference to 'EntityBrowserEnhancedPluginManager'
entity_browser_enhanced.services.yml in ./entity_browser_enhanced.services.yml
entity_browser_enhanced.services.yml
1 service uses EntityBrowserEnhancedPluginManager
plugin.manager.entity_browser_enhanced_plugin in ./entity_browser_enhanced.services.yml
Drupal\entity_browser_enhanced\EntityBrowserEnhancedPluginManager

File

src/EntityBrowserEnhancedPluginManager.php, line 15

Namespace

Drupal\entity_browser_enhanced
View source 
class EntityBrowserEnhancedPluginManager extends DefaultPluginManager {

  /**
   * Provides default values for all entity_browser_enhanced_plugin plugins.
   *
   * @var array
   */
  protected $defaults = [
    'id' => '',
    'label' => '',
    'form_extra_class' => '',
    'libraray' => '',
  ];

  /**
   * Constructs a new EntityBrowserEnhancedPluginManager 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) {
    $this->moduleHandler = $module_handler;
    $this
      ->setCacheBackend($cache_backend, 'entity_browser_enhanced_plugin', [
      'entity_browser_enhanced_plugin',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  protected function getDiscovery() {
    if (!isset($this->discovery)) {
      $this->discovery = new YamlDiscovery('enhancers', $this->moduleHandler
        ->getModuleDirectories());
      $this->discovery
        ->addTranslatableProperty('label', 'label_context');
      $this->discovery = new ContainerDerivativeDiscoveryDecorator($this->discovery);
    }
    return $this->discovery;
  }

  /**
   * {@inheritdoc}
   */
  public function processDefinition(&$definition, $plugin_id) {
    parent::processDefinition($definition, $plugin_id);
    if (empty($definition['id'])) {
      throw new PluginException(sprintf('Enhancer ID property (%s) definition "is" is required.', $plugin_id));
    }
    if (empty($definition['label'])) {
      throw new PluginException(sprintf('Enhancer Lable property (%s) definition "is" is required.', $plugin_id));
    }
    if (empty($definition['form_extra_class'])) {
      throw new PluginException(sprintf('Enhancer form extra CSS class selector property (%s) definition "is" is required.', $plugin_id));
    }
    if (empty($definition['libraray'])) {
      throw new PluginException(sprintf('Enhancer libraray (in a module or theme) property (%s) definition "is" is required.', $plugin_id));
    }
  }

  /**
   * Get Enhancer ID.
   *
   * @return string
   *   The ID of the Enhancer.
   */
  public function getId() {
    return $this->pluginDefinition['id'];
  }

  /**
   * Get Enhancer Label.
   *
   * @return string
   *   The Label of the Enhancer.
   */
  public function getLabel() {
    return $this->pluginDefinition['label'];
  }

  /**
   * Get Enhancer Form Extra CSS Class.
   *
   * @return string
   *   The selected form extra CSS class for the enhancer.
   */
  public function getFormExtraClass() {
    return $this->pluginDefinition['form_extra_class'];
  }

  /**
   * Get Enhancer styling library.
   *
   * @return string
   *   The styling library from modules or themes.
   */
  public function getLibraray() {
    return $this->pluginDefinition['libraray'];
  }

}

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::$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::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
EntityBrowserEnhancedPluginManager::$defaults protected property Provides default values for all entity_browser_enhanced_plugin plugins. Overrides DefaultPluginManager::$defaults
EntityBrowserEnhancedPluginManager::getDiscovery protected function Gets the plugin discovery. Overrides DefaultPluginManager::getDiscovery
EntityBrowserEnhancedPluginManager::getFormExtraClass public function Get Enhancer Form Extra CSS Class.
EntityBrowserEnhancedPluginManager::getId public function Get Enhancer ID.
EntityBrowserEnhancedPluginManager::getLabel public function Get Enhancer Label.
EntityBrowserEnhancedPluginManager::getLibraray public function Get Enhancer styling library.
EntityBrowserEnhancedPluginManager::processDefinition public function Performs extra processing on plugin definitions. Overrides DefaultPluginManager::processDefinition
EntityBrowserEnhancedPluginManager::__construct public function Constructs a new EntityBrowserEnhancedPluginManager 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.