class ComplexDataConstraint in Zircon Profile 8

Complex data constraint.

Validates properties of complex data structures.

Plugin annotation

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

Hierarchy

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

File

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

Contains \Drupal\Core\Validation\Plugin\Validation\Constraint\ComplexDataConstraint.

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 = array(
        '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 array(
      '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. Overrides Constraint::getDefaultOption
ComplexDataConstraint::getRequiredOptions	public	function	Returns the name of the required options. Overrides Constraint::getRequiredOptions
ComplexDataConstraint::__construct	public	function	Initializes the constraint with options. Overrides Constraint::__construct
Constraint::$errorNames	protected static	property	Maps error codes to the names of their constants.	16
Constraint::$payload	public	property	Domain-specific data attached to a constraint.
Constraint::addImplicitGroupName	public	function	Adds the given group if this constraint is in the Default group.	1
Constraint::CLASS_CONSTRAINT		constant	Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP		constant	The name of the group given to all constraints with no explicit group.
Constraint::getErrorName	public static	function	Returns the name of the given error code.
Constraint::getTargets	public	function	Returns whether the constraint can be put onto classes, properties or both.	11
Constraint::PROPERTY_CONSTRAINT		constant	Marks a constraint that can be put onto properties.
Constraint::validatedBy	public	function	Returns the name of the class that validates this constraint.	11
Constraint::__get	public	function	Returns the value of a lazily initialized option.	1
Constraint::__set	public	function	Sets the value of a lazily initialized option.	1
Constraint::__sleep	public	function	Optimizes the serialized value to minimize storage space.