You are here

Home » API reference » Conditional Fields 8 » ConditionalFieldsHandlersManager.php

class ConditionalFieldsHandlersManager in Conditional Fields 8

Same name and namespace in other branches
  1. 4.x src/ConditionalFieldsHandlersManager.php \Drupal\conditional_fields\ConditionalFieldsHandlersManager

Manages discovery and instantiation of handler plugins.

Hierarchy

Expanded class hierarchy of ConditionalFieldsHandlersManager

1 file declares its use of ConditionalFieldsHandlersManager
ConditionalFieldsFormHelper.php in src/ConditionalFieldsFormHelper.php
1 string reference to 'ConditionalFieldsHandlersManager'
conditional_fields.services.yml in ./conditional_fields.services.yml
conditional_fields.services.yml
1 service uses ConditionalFieldsHandlersManager
plugin.manager.conditional_fields_handlers in ./conditional_fields.services.yml
Drupal\conditional_fields\ConditionalFieldsHandlersManager

File

src/ConditionalFieldsHandlersManager.php, line 19

Namespace

Drupal\conditional_fields
View source 
class ConditionalFieldsHandlersManager extends DefaultPluginManager implements FallbackPluginManagerInterface {

  /**
   * Constructs a new ConditionalFieldsHandlersManager 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 to invoke the alter hook with.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/conditional_fields/handler', $namespaces, $module_handler, 'Drupal\\conditional_fields\\ConditionalFieldsHandlersPluginInterface', 'Drupal\\conditional_fields\\Annotation\\ConditionalFieldsHandler');
    $this
      ->alterInfo('handler_info');
    $this
      ->setCacheBackend($cache_backend, 'handler_plugins');
    $this->factory = new DefaultFactory($this
      ->getDiscovery());
  }

  /**
   * {@inheritdoc}
   */
  protected function getDiscovery() {
    if (!isset($this->discovery)) {
      $this->discovery = parent::getDiscovery();
      $this->discovery = new StaticDiscoveryDecorator($this->discovery, [
        $this,
        'registerDefinitions',
      ]);
    }
    return $this->discovery;
  }

  /**
   * Callback for registering definitions for constraints shipped with Symfony.
   *
   * @see ConstraintManager::__construct()
   */
  public function registerDefinitions() {
    $discovery = $this
      ->getDiscovery();
    if ($discovery instanceof StaticDiscovery) {
      $discovery
        ->setDefinition('states_handler_string_textfield', [
        'label' => new TranslatableMarkup('String textfield'),
        'class' => '\\Drupal\\conditional_fields\\Plugin\\conditional_fields\\handler\\TextDefault',
        'type' => [
          'string',
        ],
      ]);
      $discovery
        ->setDefinition('states_handler_string_textarea', [
        'label' => new TranslatableMarkup('String textarea'),
        'class' => '\\Drupal\\conditional_fields\\Plugin\\conditional_fields\\handler\\TextDefault',
        'type' => [
          'string',
        ],
      ]);
      $discovery
        ->setDefinition('states_handler_text_textfield', [
        'label' => new TranslatableMarkup('Text textfield'),
        'class' => '\\Drupal\\conditional_fields\\Plugin\\conditional_fields\\handler\\TextDefault',
        'type' => [
          'string',
        ],
      ]);
      $discovery
        ->setDefinition('states_handler_text_textarea', [
        'label' => new TranslatableMarkup('Text textarea'),
        'class' => '\\Drupal\\conditional_fields\\Plugin\\conditional_fields\\handler\\TextDefault',
        'type' => [
          'string',
        ],
      ]);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinitions() {

    // Remove the default plugin from the array.
    $definitions = parent::getDefinitions();
    unset($definitions['states_handler_default_state']);
    return $definitions;
  }

  /**
   * {@inheritdoc}
   */
  public function getFallbackPluginId($plugin_id, array $configuration = []) {
    return 'states_handler_default_state';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConditionalFieldsHandlersManager::getDefinitions public function Gets the definition of all plugins for this type. Overrides DefaultPluginManager::getDefinitions
ConditionalFieldsHandlersManager::getDiscovery protected function Gets the plugin discovery. Overrides DefaultPluginManager::getDiscovery
ConditionalFieldsHandlersManager::getFallbackPluginId public function Gets a fallback id for a missing plugin. Overrides FallbackPluginManagerInterface::getFallbackPluginId
ConditionalFieldsHandlersManager::registerDefinitions public function Callback for registering definitions for constraints shipped with Symfony.
ConditionalFieldsHandlersManager::__construct public function Constructs a new ConditionalFieldsHandlersManager 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 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::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 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.