class ComplexDataConstraint in Drupal 8

Complex data constraint.

Validates properties of complex data structures.

Plugin annotation

@Constraint(
  id = "ComplexData",
  label = @Translation("Complex data", context = "Validation")
)

Hierarchy

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

File

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

Namespace

Drupal\Core\Validation\Plugin\Validation\Constraint

class ComplexDataConstraint extends Constraint {

  /**
   * An array of constraints for contained properties, keyed by property name.
   *
   * @var array
   */
  public $properties;

  /**
   * {@inheritdoc}
   */
  public function __construct($options = NULL) {

    // Allow skipping the 'properties' key in the options.
    if (is_array($options) && !array_key_exists('properties', $options)) {
      $options = [
        'properties' => $options,
      ];
    }
    parent::__construct($options);
    $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);
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOption() {
    return 'properties';
  }

  /**
   * {@inheritdoc}
   */
  public function getRequiredOptions() {
    return [
      'properties',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ComplexDataConstraint::$properties	public	property	An array of constraints for contained properties, keyed by property name.
ComplexDataConstraint::getDefaultOption	public	function	Returns the name of the default option.
ComplexDataConstraint::getRequiredOptions	public	function	Returns the name of the required options.
ComplexDataConstraint::__construct	public	function	Initializes the constraint with options.