class ComplexDataConstraint

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ComplexDataConstraint.php \Drupal\Core\Validation\Plugin\Validation\Constraint\ComplexDataConstraint
  2. 10 core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ComplexDataConstraint.php \Drupal\Core\Validation\Plugin\Validation\Constraint\ComplexDataConstraint
  3. 9 core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ComplexDataConstraint.php \Drupal\Core\Validation\Plugin\Validation\Constraint\ComplexDataConstraint
  4. 8.9.x core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ComplexDataConstraint.php \Drupal\Core\Validation\Plugin\Validation\Constraint\ComplexDataConstraint

Complex data constraint.

Validates properties of complex data structures.

Attributes

#[Constraint(id: 'ComplexData', label: new TranslatableMarkup('Complex data', [], [ 'context' => 'Validation', ]))]

Hierarchy

  • class \Drupal\Core\Validation\Plugin\Validation\Constraint\ComplexDataConstraint extends \Symfony\Component\Validator\Constraint

Expanded class hierarchy of ComplexDataConstraint

File

View on git.drupalcode.org

core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ComplexDataConstraint.php, line 14

Namespace

Drupal\Core\Validation\Plugin\Validation\Constraint
View source 
class ComplexDataConstraint extends SymfonyConstraint {
  
  /**
   * An array of constraints for contained properties, keyed by property name.
   *
   * @var array
   */
  public $properties;
  public function __construct(?array $properties = NULL, ?array $groups = NULL, mixed $payload = NULL, ...$otherProperties) {
    if ($properties === NULL) {
      if (!empty($otherProperties)) {
        $properties = $otherProperties;
      }
      else {
        throw new \InvalidArgumentException('Properties must be passed to ComplexData constraint');
      }
    }
    parent::__construct(groups: $groups, payload: $payload);
    $this->properties = $properties;
    $constraint_manager = \Drupal::service('validation.constraint');
    // Instantiate constraint objects for array definitions.
    foreach ($this->properties as &$constraints) {
      foreach ($constraints as $id => $options) {
        if (!is_object($options)) {
          $constraints[$id] = $constraint_manager->create($id, $options);
        }
      }
    }
  }

}

Members

Title Modifiers Object type Summary
ComplexDataConstraint::$properties public property An array of constraints for contained properties, keyed by property name.
ComplexDataConstraint::__construct public function

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