class Constraint in Drupal 9

Defines a validation constraint annotation object.

Plugin Namespace: Plugin\Validation\Constraint

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

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\Core\Validation\Annotation\Constraint

See also

\Drupal\Core\Validation\ConstraintManager

\Symfony\Component\Validator\Constraint

hook_validation_constraint_alter()

Plugin API

Related topics

Annotations

Annotations for class discovery and metadata description.

56 classes are annotated with Constraint

AllowedValuesConstraint in core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/AllowedValuesConstraint.php

Checks for the value being allowed.

BookOutlineConstraint in core/modules/book/src/Plugin/Validation/Constraint/BookOutlineConstraint.php

Validation constraint for changing the book outline in pending revisions.

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.

... See full list

File

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

Namespace

Drupal\Core\Validation\Annotation

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

Name	Modifiers	Type	Description	Overrides
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.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
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	1
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.	2