class Constraint

Same name in this branch
  1. 10 core/lib/Drupal/Core/Validation/Attribute/Constraint.php \Drupal\Core\Validation\Attribute\Constraint
  2. 10 core/lib/Drupal/Component/Version/Constraint.php \Drupal\Component\Version\Constraint
Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Validation/Attribute/Constraint.php \Drupal\Core\Validation\Attribute\Constraint
  2. 11.x core/lib/Drupal/Core/Validation/Annotation/Constraint.php \Drupal\Core\Validation\Annotation\Constraint
  3. 11.x core/lib/Drupal/Component/Version/Constraint.php \Drupal\Component\Version\Constraint
  4. 9 core/lib/Drupal/Core/Validation/Annotation/Constraint.php \Drupal\Core\Validation\Annotation\Constraint
  5. 9 core/lib/Drupal/Component/Version/Constraint.php \Drupal\Component\Version\Constraint
  6. 8.9.x core/lib/Drupal/Core/Validation/Annotation/Constraint.php \Drupal\Core\Validation\Annotation\Constraint
  7. 8.9.x core/lib/Drupal/Component/Version/Constraint.php \Drupal\Component\Version\Constraint

Defines a validation constraint annotation object.

Plugin Namespace: Plugin\Validation\Constraint

For a working example, see \Drupal\Core\Validation\Plugin\Validation\Constraint\LengthConstraint

Hierarchy

Expanded class hierarchy of Constraint

See also

\Drupal\Core\Validation\ConstraintManager

\Symfony\Component\Validator\Constraint

hook_validation_constraint_alter()

Plugin API

Related topics

1 string reference to 'Constraint'
DependencyTest::testSerialization in core/tests/Drupal/Tests/Core/Extension/DependencyTest.php
Ensures that constraint objects are not serialized.
1 class is annotated with Constraint
MediaMappingsConstraint in core/modules/media/src/Plugin/Validation/Constraint/MediaMappingsConstraint.php
Validates media mappings.

File

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

Namespace

Drupal\Core\Validation\Annotation
View source
class Constraint extends Plugin {
  
  /**
   * The constraint plugin ID.
   *
   * @var string
   */
  public $id;
  
  /**
   * The human-readable name of the constraint plugin.
   *
   * @ingroup plugin_translatable
   *
   * @var string|\Drupal\Core\Annotation\Translation
   */
  public $label;
  
  /**
   * DataType plugin IDs for which this constraint applies.
   *
   * Valid values are any types registered by the typed data API, or an array
   * of multiple type names. For supporting all types, FALSE may be specified.
   * The key defaults to an empty array, which indicates no types are supported.
   *
   * @var string|string[]|false
   *
   * @see \Drupal\Core\TypedData\Annotation\DataType
   */
  public $type = [];

}

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