class ValidSequenceKeysConstraint
Checks that all the keys of a sequence match the specified constraints.
Attributes
#[Constraint(id: 'ValidSequenceKeys', label: new TranslatableMarkup('Valid sequence keys', [], [
'context' => 'Validation',
]), type: [
'sequence',
])]
Hierarchy
- class \Drupal\Core\Validation\Plugin\Validation\Constraint\ValidSequenceKeysConstraint implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Symfony\Component\Validator\Constraints\Composite
Expanded class hierarchy of ValidSequenceKeysConstraint
1 file declares its use of ValidSequenceKeysConstraint
- ValidSequenceKeysValidatorTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Validation/ ValidSequenceKeysValidatorTest.php
File
-
core/
lib/ Drupal/ Core/ Validation/ Plugin/ Validation/ Constraint/ ValidSequenceKeysConstraint.php, line 17
Namespace
Drupal\Core\Validation\Plugin\Validation\ConstraintView source
class ValidSequenceKeysConstraint extends Composite implements ContainerFactoryPluginInterface {
/**
* The error message if a sequence key is invalid.
*
* @var string
*/
public string $message = 'The keys of the sequence do not match the given constraints.';
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) : static {
$constraint_manager = $container->get('validation.constraint');
$constraints = $configuration['constraints'];
$constraint_instances = [];
foreach ($constraints as $constraint_name => $constraint_options) {
$constraint_instances[$constraint_name] = $constraint_manager->create($constraint_name, $constraint_options);
}
return new static([
'constraints' => $constraint_instances,
], [
SymfonyConstraint::DEFAULT_GROUP,
]);
}
/**
* Constraint IDs + options specified that are to be applied to sequence keys.
*
* @var \Symfony\Component\Validator\Constraint[]
*/
public array $constraints;
/**
* {@inheritdoc}
*/
public function getDefaultOption() : ?string {
return 'constraints';
}
/**
* {@inheritdoc}
*/
public function getRequiredOptions() : array {
return [
'constraints',
];
}
/**
* {@inheritdoc}
*/
protected function getCompositeOption() : string {
return 'constraints';
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
|---|---|---|---|---|
| ValidSequenceKeysConstraint::$constraints | public | property | Constraint IDs + options specified that are to be applied to sequence keys. | |
| ValidSequenceKeysConstraint::$message | public | property | The error message if a sequence key is invalid. | |
| ValidSequenceKeysConstraint::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create |
| ValidSequenceKeysConstraint::getCompositeOption | protected | function | ||
| ValidSequenceKeysConstraint::getDefaultOption | public | function | ||
| ValidSequenceKeysConstraint::getRequiredOptions | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.