1. 8.2.x vendor/composer/semver/src/Constraint/Constraint.php Constraint
  2. 8.2.x vendor/symfony/validator/Constraint.php Constraint
  3. 8.2.x core/lib/Drupal/Core/Validation/Annotation/Constraint.php Constraint
  4. 8.0.x core/lib/Drupal/Core/Validation/Annotation/Constraint.php Constraint
  5. 8.0.x vendor/symfony/validator/Constraint.php Constraint
  6. 8.0.x vendor/composer/semver/src/Constraint/Constraint.php Constraint
  7. 8.1.x core/lib/Drupal/Core/Validation/Annotation/Constraint.php Constraint
  8. 8.1.x vendor/composer/semver/src/Constraint/Constraint.php Constraint
  9. 8.1.x vendor/symfony/validator/Constraint.php Constraint
  10. 8.3.x core/lib/Drupal/Core/Validation/Annotation/Constraint.php Constraint
  11. 8.3.x vendor/symfony/validator/Constraint.php Constraint
  12. 8.3.x vendor/composer/semver/src/Constraint/Constraint.php 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

35 classes are annotated with Constraint
BundleConstraint in core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/BundleConstraint.php
Checks if a value is a valid entity type.
CommentNameConstraint in core/modules/comment/src/Plugin/Validation/Constraint/CommentNameConstraint.php
Supports validating comment author names.
ComplexDataConstraint in core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ComplexDataConstraint.php
Complex data constraint.
CountConstraint in core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/CountConstraint.php
Count constraint.
EmailConstraint in core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/EmailConstraint.php
Count constraint.

... See full list

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;

  /**
   * An array of 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 = [];

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
Constraint::$id public property The constraint plugin ID.
Constraint::$label public property The human-readable name of the constraint plugin.
Constraint::$type public property An array of 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,…
Plugin::$definition protected property The plugin definition read from the class annotation.
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object.