class ConstraintManager in Zircon Profile 8.0

Same name and namespace in other branches

8 core/lib/Drupal/Core/Validation/ConstraintManager.php \Drupal\Core\Validation\ConstraintManager

Constraint plugin manager.

Manages validation constraints based upon \Symfony\Component\Validator\Constraint, whereas Symfony constraints are added in manually during construction. Constraint options are passed on as plugin configuration during plugin instantiation.

While core does not prefix constraint plugins, modules have to prefix them with the module name in order to avoid any naming conflicts. E.g. a "profile" module would have to prefix any constraints with "Profile".

Constraint plugins may specify data types to which support is limited via the 'type' key of plugin definitions. See \Drupal\Core\Validation\Annotation\Constraint for details.

View source

class ConstraintManager extends DefaultPluginManager {

  /**
   * Overrides \Drupal\Component\Plugin\PluginManagerBase::__construct().
   *
   * @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/Validation/Constraint', $namespaces, $module_handler, NULL, 'Drupal\\Core\\Validation\\Annotation\\Constraint');
    $this
      ->alterInfo('validation_constraint');
    $this
      ->setCacheBackend($cache_backend, 'validation_constraint_plugins');
  }

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

  /**
   * Creates a validation constraint.
   *
   * @param string $name
   *   The name or plugin id of the constraint.
   * @param mixed $options
   *   The options to pass to the constraint class. Required and supported
   *   options depend on the constraint class.
   *
   * @return \Symfony\Component\Validator\Constraint
   *   A validation constraint plugin.
   */
  public function create($name, $options) {
    if (!is_array($options)) {

      // Plugins need an array as configuration, so make sure we have one.
      // The constraint classes support passing the options as part of the
      // 'value' key also.
      $options = isset($options) ? array(
        'value' => $options,
      ) : array();
    }
    return $this
      ->createInstance($name, $options);
  }

  /**
   * Callback for registering definitions for constraints shipped with Symfony.
   *
   * @see ConstraintManager::__construct()
   */
  public function registerDefinitions() {
    $this
      ->getDiscovery()
      ->setDefinition('Callback', array(
      'label' => new TranslatableMarkup('Callback'),
      'class' => '\\Symfony\\Component\\Validator\\Constraints\\Callback',
      'type' => FALSE,
    ));
    $this
      ->getDiscovery()
      ->setDefinition('Blank', array(
      'label' => new TranslatableMarkup('Blank'),
      'class' => '\\Symfony\\Component\\Validator\\Constraints\\Blank',
      'type' => FALSE,
    ));
    $this
      ->getDiscovery()
      ->setDefinition('NotBlank', array(
      'label' => new TranslatableMarkup('Not blank'),
      'class' => '\\Symfony\\Component\\Validator\\Constraints\\NotBlank',
      'type' => FALSE,
    ));
    $this
      ->getDiscovery()
      ->setDefinition('Email', array(
      'label' => new TranslatableMarkup('Email'),
      'class' => '\\Drupal\\Core\\Validation\\Plugin\\Validation\\Constraint\\EmailConstraint',
      'type' => array(
        'string',
      ),
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function processDefinition(&$definition, $plugin_id) {

    // Make sure 'type' is set and either an array or FALSE.
    if ($definition['type'] !== FALSE && !is_array($definition['type'])) {
      $definition['type'] = array(
        $definition['type'],
      );
    }
  }

  /**
   * Returns a list of constraints that support the given type.
   *
   * @param string $type
   *   The type to filter on.
   *
   * @return array
   *   An array of constraint plugin definitions supporting the given type,
   *   keyed by constraint name (plugin ID).
   */
  public function getDefinitionsByType($type) {
    $definitions = array();
    foreach ($this
      ->getDefinitions() as $plugin_id => $definition) {
      if ($definition['type'] === FALSE || in_array($type, $definition['type'])) {
        $definitions[$plugin_id] = $definition;
      }
    }
    return $definitions;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConstraintManager::create	public	function	Creates a validation constraint.
ConstraintManager::getDefinitionsByType	public	function	Returns a list of constraints that support the given type.
ConstraintManager::getDiscovery	protected	function	Gets the plugin discovery. Overrides DefaultPluginManager::getDiscovery
ConstraintManager::processDefinition	public	function	Performs extra processing on plugin definitions. Overrides DefaultPluginManager::processDefinition
ConstraintManager::registerDefinitions	public	function	Callback for registering definitions for constraints shipped with Symfony.
ConstraintManager::__construct	public	function	Overrides \Drupal\Component\Plugin\PluginManagerBase::__construct(). Overrides DefaultPluginManager::__construct
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.	5
DefaultPluginManager::$moduleHandler	protected	property	The module handler to invoke the alter hook.
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.
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	Initializes the alter hook.
DefaultPluginManager::clearCachedDefinitions	public	function	Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions	4
DefaultPluginManager::findDefinitions	protected	function	Finds plugin definitions.	2
DefaultPluginManager::getCachedDefinitions	protected	function	Returns the cached plugin definitions of the decorated discovery class.
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.	1
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	11
PluginManagerBase::getInstance	public	function	Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance	7
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.
UseCacheBackendTrait::cacheSet	protected	function	Stores data in the persistent cache, respecting the use caches flag.

You are here

class ConstraintManager in Zircon Profile 8.0

Hierarchy

See also

File

Namespace

Members

API Navigation