class ValidKeysConstraint
Same name and namespace in other branches
- 11.x core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ValidKeysConstraint.php \Drupal\Core\Validation\Plugin\Validation\Constraint\ValidKeysConstraint
- 10 core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ValidKeysConstraint.php \Drupal\Core\Validation\Plugin\Validation\Constraint\ValidKeysConstraint
Checks that all the keys of a mapping are valid and required keys present.
Attributes
#[Constraint(id: 'ValidKeys', label: new TranslatableMarkup('Valid mapping keys', [], [
'context' => 'Validation',
]), type: [
'mapping',
])]
Hierarchy
- class \Drupal\Core\Validation\Plugin\Validation\Constraint\ValidKeysConstraint extends \Symfony\Component\Validator\Constraint
Expanded class hierarchy of ValidKeysConstraint
2 files declare their use of ValidKeysConstraint
- ConstraintFactoryTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Validation/ ConstraintFactoryTest.php - ValidKeysConstraintValidatorTest.php in core/
tests/ Drupal/ KernelTests/ Core/ TypedData/ ValidKeysConstraintValidatorTest.php
File
-
core/
lib/ Drupal/ Core/ Validation/ Plugin/ Validation/ Constraint/ ValidKeysConstraint.php, line 18
Namespace
Drupal\Core\Validation\Plugin\Validation\ConstraintView source
class ValidKeysConstraint extends SymfonyConstraint {
/**
* Keys which are allowed in the validated array, or `<infer>` to auto-detect.
*
* @var array|string
*/
public array|string $allowedKeys;
public function __construct(mixed $options = NULL, array|string|null $allowedKeys = NULL, public string $invalidKeyMessage = "'@key' is not a supported key.", public string $dynamicInvalidKeyMessage = "'@key' is an unknown key because @dynamic_type_property_path is @dynamic_type_property_value (see config schema type @resolved_dynamic_type).", public string $missingRequiredKeyMessage = "'@key' is a required key.", public string $dynamicMissingRequiredKeyMessage = "'@key' is a required key because @dynamic_type_property_path is @dynamic_type_property_value (see config schema type @resolved_dynamic_type).", public string $indexedArrayMessage = 'Numerically indexed arrays are not allowed.', ?array $groups = NULL, mixed $payload = NULL) {
parent::__construct($options, $groups, $payload);
$this->allowedKeys = $allowedKeys ?? $this->allowedKeys;
}
/**
* {@inheritdoc}
*/
public function getDefaultOption() : ?string {
return 'allowedKeys';
}
/**
* {@inheritdoc}
*/
public function getRequiredOptions() : array {
return [
'allowedKeys',
];
}
/**
* Returns the list of valid keys.
*
* @param \Symfony\Component\Validator\Context\ExecutionContextInterface $context
* The current execution context.
*
* @return string[]
* The keys that will be considered valid.
*/
public function getAllowedKeys(ExecutionContextInterface $context) : array {
$mapping = $context->getObject();
assert($mapping instanceof Mapping);
$resolved_type = $mapping->getDataDefinition()
->getDataType();
$valid_keys = $mapping->getValidKeys();
// If we were given an explicit array of allowed keys, return that.
if (is_array($this->allowedKeys)) {
if (!empty(array_diff($this->allowedKeys, $valid_keys))) {
throw new InvalidArgumentException(sprintf('The type \'%s\' explicitly specifies the allowed keys (%s), but they are not a subset of the statically defined mapping keys in the schema (%s).', $resolved_type, implode(', ', $this->allowedKeys), implode(', ', $valid_keys)));
}
return array_intersect($valid_keys, $this->allowedKeys);
}
elseif ($this->allowedKeys === '<infer>') {
return $mapping->getValidKeys();
}
throw new InvalidArgumentException("'{$this->allowedKeys}' is not a valid set of allowed keys.");
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary |
|---|---|---|---|
| ValidKeysConstraint::$allowedKeys | public | property | Keys which are allowed in the validated array, or `<infer>` to auto-detect. |
| ValidKeysConstraint::getAllowedKeys | public | function | Returns the list of valid keys. |
| ValidKeysConstraint::getDefaultOption | public | function | |
| ValidKeysConstraint::getRequiredOptions | public | function | |
| ValidKeysConstraint::__construct | public | function | #[HasNamedArguments] |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.