class Choice
Validates that a value is one of a given set of valid choices.
@author Bernhard Schussek <bschussek@gmail.com>
Hierarchy
- class \Symfony\Component\Validator\Constraint
- class \Symfony\Component\Validator\Constraints\Choice extends \Symfony\Component\Validator\Constraint
Expanded class hierarchy of Choice
7 files declare their use of Choice
- AllowedValuesConstraint.php in core/
lib/ Drupal/ Core/ Validation/ Plugin/ Validation/ Constraint/ AllowedValuesConstraint.php - ConstraintManager.php in core/
lib/ Drupal/ Core/ Validation/ ConstraintManager.php - CountryCodeConstraint.php in core/
lib/ Drupal/ Core/ Validation/ Plugin/ Validation/ Constraint/ CountryCodeConstraint.php - ProjectRelease.php in core/
modules/ update/ src/ ProjectRelease.php - Recipe.php in core/
lib/ Drupal/ Core/ Recipe/ Recipe.php
2 string references to 'Choice'
- ConstraintManager::registerDefinitions in core/
lib/ Drupal/ Core/ Validation/ ConstraintManager.php - Callback for registering definitions for constraints shipped with Symfony.
- Recipe::parse in core/
lib/ Drupal/ Core/ Recipe/ Recipe.php - Parses and validates a recipe.yml file.
File
-
vendor/
symfony/ validator/ Constraints/ Choice.php, line 21
Namespace
Symfony\Component\Validator\ConstraintsView source
class Choice extends Constraint {
public const NO_SUCH_CHOICE_ERROR = '8e179f1b-97aa-4560-a02f-2a8b42e49df7';
public const TOO_FEW_ERROR = '11edd7eb-5872-4b6e-9f12-89923999fd0e';
public const TOO_MANY_ERROR = '9bd98e49-211c-433f-8630-fd1c2d0f08c3';
protected const ERROR_NAMES = [
self::NO_SUCH_CHOICE_ERROR => 'NO_SUCH_CHOICE_ERROR',
self::TOO_FEW_ERROR => 'TOO_FEW_ERROR',
self::TOO_MANY_ERROR => 'TOO_MANY_ERROR',
];
public ?array $choices = null;
/** @var callable|string|null */
public $callback;
public bool $multiple = false;
public bool $strict = true;
public ?int $min = null;
public ?int $max = null;
public string $message = 'The value you selected is not a valid choice.';
public string $multipleMessage = 'One or more of the given values is invalid.';
public string $minMessage = 'You must select at least {{ limit }} choice.|You must select at least {{ limit }} choices.';
public string $maxMessage = 'You must select at most {{ limit }} choice.|You must select at most {{ limit }} choices.';
public bool $match = true;
public function getDefaultOption() : ?string {
return 'choices';
}
/**
* @param array|null $choices An array of choices (required unless a callback is specified)
* @param callable|string|null $callback Callback method to use instead of the choice option to get the choices
* @param bool|null $multiple Whether to expect the value to be an array of valid choices (defaults to false)
* @param bool|null $strict This option defaults to true and should not be used
* @param int<0, max>|null $min Minimum of valid choices if multiple values are expected
* @param positive-int|null $max Maximum of valid choices if multiple values are expected
* @param string[]|null $groups
* @param bool|null $match Whether to validate the values are part of the choices or not (defaults to true)
*/
public function __construct(string|array $options = [], ?array $choices = null, callable|string|null $callback = null, ?bool $multiple = null, ?bool $strict = null, ?int $min = null, ?int $max = null, ?string $message = null, ?string $multipleMessage = null, ?string $minMessage = null, ?string $maxMessage = null, ?array $groups = null, mixed $payload = null, ?bool $match = null) {
if (\is_array($options) && $options && array_is_list($options)) {
$choices ??= $options;
$options = [];
}
if (null !== $choices) {
$options['value'] = $choices;
}
parent::__construct($options, $groups, $payload);
$this->callback = $callback ?? $this->callback;
$this->multiple = $multiple ?? $this->multiple;
$this->strict = $strict ?? $this->strict;
$this->min = $min ?? $this->min;
$this->max = $max ?? $this->max;
$this->message = $message ?? $this->message;
$this->multipleMessage = $multipleMessage ?? $this->multipleMessage;
$this->minMessage = $minMessage ?? $this->minMessage;
$this->maxMessage = $maxMessage ?? $this->maxMessage;
$this->match = $match ?? $this->match;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
Choice::$callback | public | property | @var callable|string|null | ||
Choice::$choices | public | property | |||
Choice::$match | public | property | |||
Choice::$max | public | property | |||
Choice::$maxMessage | public | property | |||
Choice::$message | public | property | |||
Choice::$min | public | property | |||
Choice::$minMessage | public | property | |||
Choice::$multiple | public | property | |||
Choice::$multipleMessage | public | property | |||
Choice::$strict | public | property | |||
Choice::ERROR_NAMES | protected | constant | Maps error codes to the names of their constants. | Overrides Constraint::ERROR_NAMES | |
Choice::getDefaultOption | public | function | Returns the name of the default option. | Overrides Constraint::getDefaultOption | |
Choice::NO_SUCH_CHOICE_ERROR | public | constant | |||
Choice::TOO_FEW_ERROR | public | constant | |||
Choice::TOO_MANY_ERROR | public | constant | |||
Choice::__construct | public | function | Overrides Constraint::__construct | 1 | |
Constraint::$groups | public | property | The groups that the constraint belongs to. | ||
Constraint::$payload | public | property | Domain-specific data attached to a constraint. | ||
Constraint::addImplicitGroupName | public | function | Adds the given group if this constraint is in the Default group. | 2 | |
Constraint::CLASS_CONSTRAINT | public | constant | Marks a constraint that can be put onto classes. | ||
Constraint::DEFAULT_GROUP | public | constant | The name of the group given to all constraints with no explicit group. | ||
Constraint::getErrorName | public static | function | Returns the name of the given error code. | ||
Constraint::getRequiredOptions | public | function | Returns the name of the required options. | 22 | |
Constraint::getTargets | public | function | Returns whether the constraint can be put onto classes, properties or both. |
8 | |
Constraint::normalizeOptions | protected | function | |||
Constraint::PROPERTY_CONSTRAINT | public | constant | Marks a constraint that can be put onto properties. | ||
Constraint::validatedBy | public | function | Returns the name of the class that validates this constraint. | 9 | |
Constraint::__get | public | function | Returns the value of a lazily initialized option. | 2 | |
Constraint::__isset | public | function | 1 | ||
Constraint::__set | public | function | Sets the value of a lazily initialized option. | 1 | |
Constraint::__sleep | public | function | Optimizes the serialized value to minimize storage space. |