Same name in this branch
- 10 core/lib/Drupal/Component/Version/Constraint.php \Drupal\Component\Version\Constraint
- 10 core/lib/Drupal/Core/Validation/Annotation/Constraint.php \Drupal\Core\Validation\Annotation\Constraint
Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Validation/Annotation/Constraint.php \Drupal\Core\Validation\Annotation\Constraint
- 9 core/lib/Drupal/Core/Validation/Annotation/Constraint.php \Drupal\Core\Validation\Annotation\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
- class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
- class \Drupal\Core\Validation\Annotation\Constraint
Expanded class hierarchy of Constraint
See also
\Drupal\Core\Validation\ConstraintManager
\Symfony\Component\Validator\Constraint
hook_validation_constraint_alter()
Related topics
File
- core/
lib/ Drupal/ Core/ Validation/ Annotation/ Constraint.php, line 22
Namespace
Drupal\Core\Validation\AnnotationView 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 = [];
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Plugin:: |
public | function | Constructs a Plugin object. | 3 |
Plugin:: |
public | function |
Sets the name of the provider of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Sets the class of the annotated class. Overrides AnnotationInterface:: |
1 |
Plugin:: |
protected | function | Parses an annotation into its definition. | |
Plugin:: |
public | function |
Gets the name of the provider of the annotated class. Overrides AnnotationInterface:: |
1 |
Plugin:: |
public | function |
Gets the unique ID for this annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Gets the class of the annotated class. Overrides AnnotationInterface:: |
1 |
Plugin:: |
public | function |
Gets the value of an annotation. Overrides AnnotationInterface:: |
6 |
Plugin:: |
protected | property | The plugin definition read from the class annotation. | 1 |
Constraint:: |
public | property | DataType plugin IDs for which this constraint applies. | |
Constraint:: |
public | property | The human-readable name of the constraint plugin. | |
Constraint:: |
public | property | The constraint plugin ID. |