You are here

Home » API reference » Form API Validation 8.2 » FapiValidationValidatorsManager.php

class FapiValidationValidatorsManager in Form API Validation 8.2

A plugin manager for Fapi Validaton Validators Plugin.

Hierarchy

Expanded class hierarchy of FapiValidationValidatorsManager

1 string reference to 'FapiValidationValidatorsManager'
fapi_validation.services.yml in ./fapi_validation.services.yml
fapi_validation.services.yml
1 service uses FapiValidationValidatorsManager
plugin.manager.fapi_validation_validators in ./fapi_validation.services.yml
Drupal\fapi_validation\FapiValidationValidatorsManager

File

src/FapiValidationValidatorsManager.php, line 13

Namespace

Drupal\fapi_validation
View source 
class FapiValidationValidatorsManager extends DefaultPluginManager {

  /**
   * Constructs a MessageManager 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) {
    $this
      ->alterInfo('fapi_validation_validators_info');
    $this
      ->setCacheBackend($cache_backend, 'fapi_validation_validators');
    parent::__construct('Plugin/FapiValidationValidator', $namespaces, $module_handler, 'Drupal\\fapi_validation\\FapiValidationValidatorsInterface', 'Drupal\\fapi_validation\\Annotation\\FapiValidationValidator');
  }

  /**
   * Check if Valildator Plugin exists.
   *
   * @param string $id
   *   Validators Name.
   *
   * @return bool
   *   Check
   */
  public function hasValidator($id) {
    return in_array($id, array_keys($this
      ->getDefinitions()));
  }

  /**
   * Execute validation.
   *
   * @param array &$element
   *   Form Element.
   * @param \Drupal\Core\Form\FormStateInterface &$form_state
   *   Form State Object.
   */
  public function validate(array &$element, FormStateInterface &$form_state) {

    // If element is empty and not required, by pass rule validation.
    if (!$element['#required'] && empty($element['#value']) && $element['#value'] !== 0) {
      return;
    }
    $def = $element['#validators'];
    foreach ($def as $raw_validation) {

      // Parse Validator.
      $validator = new Validator($raw_validation, $form_state
        ->getValue($element['#parents']));
      if (!$this
        ->hasValidator($validator
        ->getName())) {

        // @TODO throw Validator not found
        throw new \LogicException("Invalid validator name '{$validator->getName()}'.");
      }
      $plugin = $this
        ->getDefinition($validator
        ->getName());
      $instance = $this
        ->createInstance($plugin['id']);
      if (!$instance
        ->validate($validator, $element, $form_state)) {
        $error_message = $this
          ->processErrorMessage($validator, $plugin, $element);
        $form_state
          ->setError($element, $error_message);
      }
    }
  }

  /**
   * Process Error Message.
   *
   * @param \Drupal\fapi_validation\Validator $validator
   *   Validator.
   * @param array $plugin
   *   Plugin data.
   * @param array $element
   *   Form Element.
   *
   * @return string
   *   Error messaage.
   */
  protected function processErrorMessage(Validator $validator, array $plugin, array $element) {

    // User defined error callback?
    if ($validator
      ->hasErrorCallbackDefined()) {
      return call_user_func_array($validator
        ->getErrorCallback(), [
        $validator,
        $element,
      ]);
    }
    elseif ($validator
      ->hasErrorMessageDefined()) {
      $message = $validator
        ->getErrorMessage();
    }
    elseif ($plugin['error_callback'] !== NULL) {
      return call_user_func_array([
        $plugin['class'],
        $plugin['error_callback'],
      ], [
        $validator,
        $element,
      ]);
    }
    elseif ($plugin['error_message'] !== NULL) {
      $message = $plugin['error_message'];
    }
    else {
      $message = "Unespecified validator error message for field %field.";
    }
    return \t($message, [
      '%field' => $element['#title'],
    ]);
  }

}

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
FapiValidationValidatorsManager::hasValidator public function Check if Valildator Plugin exists.
FapiValidationValidatorsManager::processErrorMessage protected function Process Error Message.
FapiValidationValidatorsManager::validate public function Execute validation.
FapiValidationValidatorsManager::__construct public function Constructs a MessageManager 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.