You are here

Home » API reference » Two-factor Authentication (TFA) 8 » TfaValidationPluginManager.php

class TfaValidationPluginManager in Two-factor Authentication (TFA) 8

The validation plugin manager.

Hierarchy

Expanded class hierarchy of TfaValidationPluginManager

7 files declare their use of TfaValidationPluginManager
BasicOverview.php in src/Form/BasicOverview.php
BasicSetup.php in src/Form/BasicSetup.php
EntryForm.php in src/Form/EntryForm.php
GenericValidation.php in services_tfa/src/Plugin/ServiceDefinition/GenericValidation.php
SettingsForm.php in src/Form/SettingsForm.php

... See full list

1 string reference to 'TfaValidationPluginManager'
tfa.services.yml in ./tfa.services.yml
tfa.services.yml
1 service uses TfaValidationPluginManager
plugin.manager.tfa.validation in ./tfa.services.yml
Drupal\tfa\TfaValidationPluginManager

File

src/TfaValidationPluginManager.php, line 18

Namespace

Drupal\tfa
View source 
class TfaValidationPluginManager extends DefaultPluginManager {
  use DiscoveryCachedTrait;

  /**
   * Provides the user data service object.
   *
   * @var \Drupal\user\UserDataInterface
   */
  protected $userData;

  /**
   * Encryption profile manager.
   *
   * @var \Drupal\encrypt\EncryptionProfileManagerInterface
   */
  protected $encryptionProfileManager;

  /**
   * Encryption service.
   *
   * @var \Drupal\encrypt\EncryptService
   */
  protected $encryptService;

  /**
   * Constructs a new TfaValidation plugin manager.
   *
   * @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.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   * @param \Drupal\user\UserDataInterface $user_data
   *   User data service.
   * @param \Drupal\encrypt\EncryptionProfileManagerInterface $encryption_profile_manager
   *   Encryption profile manager.
   * @param \Drupal\encrypt\EncryptServiceInterface $encrypt_service
   *   Encryption service.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, ConfigFactoryInterface $config_factory, UserDataInterface $user_data, EncryptionProfileManagerInterface $encryption_profile_manager, EncryptServiceInterface $encrypt_service) {
    parent::__construct('Plugin/TfaValidation', $namespaces, $module_handler, 'Drupal\\tfa\\Plugin\\TfaValidationInterface', 'Drupal\\tfa\\Annotation\\TfaValidation');
    $this
      ->alterInfo('tfa_validation');
    $this
      ->setCacheBackend($cache_backend, 'tfa_validation');
    $this->userData = $user_data;
    $this->encryptService = $encrypt_service;
    $this->encryptionProfileManager = $encryption_profile_manager;
  }

  /**
   * Create an instance of a validation plugin.
   *
   * @param string $plugin_id
   *   The id of the setup plugin.
   * @param array $configuration
   *   Configuration data for the setup plugin.
   *
   * @return object
   *   Required validation plugin instance
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  public function createInstance($plugin_id, array $configuration = []) {
    $plugin_definition = $this
      ->getDefinition($plugin_id);
    $plugin_class = DefaultFactory::getPluginClass($plugin_id, $plugin_definition);

    // If the plugin provides a factory method, pass the container to it.
    if (is_subclass_of($plugin_class, 'Drupal\\Core\\Plugin\\ContainerFactoryPluginInterface')) {

      // phpcs:ignore DrupalPractice.Objects.GlobalDrupal.GlobalDrupal
      $plugin = $plugin_class::create(\Drupal::getContainer(), $configuration, $plugin_id, $plugin_definition, $this->userData, $this->encryptionProfileManager, $this->encryptService);
    }
    else {
      $plugin = new $plugin_class($configuration, $plugin_id, $plugin_definition, $this->userData, $this->encryptionProfileManager, $this->encryptService);
    }
    return $plugin;
  }

  /**
   * {@inheritdoc}
   *
   * Provide some backwards compatibility with the old implicit setupPluginId.
   * This will give other modules more time to update their plugins.
   *
   * @deprecated in tfa:8.x-1.0-alpha7 and is removed from tfa:8.x-2.0. Please
   * specify the setupPluginId property in the plugin annotation.
   * @see https://www.drupal.org/project/tfa/issues/2925066
   */
  public function getDefinitions() {
    $definitions = parent::getDefinitions();
    foreach ($definitions as &$definition) {
      if (empty($definition['setupPluginId'])) {
        $definition['setupPluginId'] = $definition['id'] . '_setup';
      }
    }
    return $definitions;
  }

  /**
   * {@inheritdoc}
   *
   * Provide some backwards compatibility with the old implicit setupPluginId.
   * This will give other modules more time to update their plugins.
   *
   * @deprecated in tfa:8.x-1.0-alpha7 and is removed from tfa:8.x-2.0. Please
   * specify the setupPluginId property in the plugin annotation.
   * @see https://www.drupal.org/project/tfa/issues/2925066
   */
  public function getDefinition($plugin_id, $exception_on_invalid = TRUE) {
    $plugin = parent::getDefinition($plugin_id, $exception_on_invalid);
    if (is_array($plugin) && empty($plugin['setupPluginId'])) {
      $plugin['setupPluginId'] = $plugin_id . '_setup';
    }
    return $plugin;
  }

}

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::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
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::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
TfaValidationPluginManager::$encryptionProfileManager protected property Encryption profile manager.
TfaValidationPluginManager::$encryptService protected property Encryption service.
TfaValidationPluginManager::$userData protected property Provides the user data service object.
TfaValidationPluginManager::createInstance public function Create an instance of a validation plugin. Overrides PluginManagerBase::createInstance
TfaValidationPluginManager::getDefinition Deprecated public function Provide some backwards compatibility with the old implicit setupPluginId. This will give other modules more time to update their plugins. Overrides DiscoveryCachedTrait::getDefinition
TfaValidationPluginManager::getDefinitions Deprecated public function Provide some backwards compatibility with the old implicit setupPluginId. This will give other modules more time to update their plugins. Overrides DiscoveryTrait::getDefinitions
TfaValidationPluginManager::__construct public function Constructs a new TfaValidation plugin manager. Overrides DefaultPluginManager::__construct
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.