class ConstraintFactory

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Validation/ConstraintFactory.php \Drupal\Core\Validation\ConstraintFactory
  2. 10 core/lib/Drupal/Core/Validation/ConstraintFactory.php \Drupal\Core\Validation\ConstraintFactory
  3. 9 core/lib/Drupal/Core/Validation/ConstraintFactory.php \Drupal\Core\Validation\ConstraintFactory

Constraint plugin factory.

Symfony Constraint plugins are created as Drupal plugins, but the default plugin constructor is not compatible.

Hierarchy

Expanded class hierarchy of ConstraintFactory

1 file declares its use of ConstraintFactory
ConstraintFactoryTest.php in core/tests/Drupal/KernelTests/Core/Validation/ConstraintFactoryTest.php

File

core/lib/Drupal/Core/Validation/ConstraintFactory.php, line 15

Namespace

Drupal\Core\Validation
View source
class ConstraintFactory extends ContainerFactory {
  
  /**
   * {@inheritdoc}
   */
  public function createInstance($plugin_id, array $configuration = []) {
    if ($configuration && array_is_list($configuration)) {
      throw new \InvalidArgumentException('$configuration must be an associative array.');
    }
    $plugin_definition = $this->discovery
      ->getDefinition($plugin_id);
    $plugin_class = static::getPluginClass($plugin_id, $plugin_definition, $this->interface);
    if (is_subclass_of($plugin_class, CompositeConstraintInterface::class)) {
      $composite_constraint_options = (array) $plugin_class::getCompositeOptionStatic();
      foreach ($composite_constraint_options as $option) {
        // Skip if no constraints are set in the configuration.
        if (!isset($configuration[$option])) {
          continue;
        }
        foreach ($configuration[$option] as $key => $value) {
          foreach ($value as $nested_constraint_id => $nested_constraint_configuration) {
            $configuration[$option][$key] = $this->createInstance($nested_constraint_id, $nested_constraint_configuration);
          }
        }
      }
    }
    // If the plugin provides a factory method, pass the container to it.
    if (is_subclass_of($plugin_class, ContainerFactoryPluginInterface::class)) {
      return $plugin_class::create(\Drupal::getContainer(), $configuration, $plugin_id, $plugin_definition);
    }
    // If the plugin is a Symfony Constraint, use the correct constructor.
    if (is_subclass_of($plugin_class, Constraint::class)) {
      return new $plugin_class(...$configuration);
    }
    // Otherwise, create the plugin as normal.
    return new $plugin_class($configuration, $plugin_id, $plugin_definition);
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConstraintFactory::createInstance public function Creates a plugin instance based on the provided ID and configuration. Overrides ContainerFactory::createInstance
DefaultFactory::$discovery protected property The object that gets the plugin definitions that this factory instantiates.
DefaultFactory::$interface protected property Defines an interface each plugin should implement.
DefaultFactory::getPluginClass public static function Finds the class relevant for a given plugin. 1
DefaultFactory::__construct public function Constructs a Drupal\Component\Plugin\Factory\DefaultFactory object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.