feature #45977 [Validator] Add the match option to the Choice constraint (fancyweb)

This PR was merged into the 6.2 branch.

Discussion
----------

[Validator] Add the match option to the Choice constraint

| Q             | A
| ------------- | ---
| Branch?       | 6.1
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Tickets       | symfony/symfony#26074
| License       | MIT
| Doc PR        | -

I'd like to add a `match` option like the one in the `Regex` constraint to validate that a value is **not** in a given set of choices.

Reusing the `Choice` constraint with a flag instead of creating the `NotChoice` constraint looks way better to me.

Commits
-------

0f7f4aa1c0 [Validator] Add the match option to the Choice constraint

Author: fabpot

CHANGELOG.md

@@ -14,6 +14,7 @@ CHANGELOG
  * Deprecate constraint `ExpressionLanguageSyntax`, use `ExpressionSyntax` instead
  * Add method `__toString()` to `ConstraintViolationInterface` & `ConstraintViolationListInterface`
  * Allow creating constraints with required arguments
+ * Add the `match` option to the `Choice` constraint
 
 6.0
 ---

Constraints/Choice.php

@@ -47,6 +47,7 @@ class Choice extends Constraint
     public $multipleMessage = 'One or more of the given values is invalid.';
     public $minMessage = 'You must select at least {{ limit }} choice.|You must select at least {{ limit }} choices.';
     public $maxMessage = 'You must select at most {{ limit }} choice.|You must select at most {{ limit }} choices.';
+    public bool $match = true;
 
     /**
      * {@inheritdoc}
@@ -69,7 +70,8 @@ public function __construct(
         string $minMessage = null,
         string $maxMessage = null,
         array $groups = null,
-        mixed $payload = null
+        mixed $payload = null,
+        bool $match = null,
     ) {
         if (\is_array($options) && $options && array_is_list($options)) {
             $choices ??= $options;
@@ -90,5 +92,6 @@ public function __construct(
         $this->multipleMessage = $multipleMessage ?? $this->multipleMessage;
         $this->minMessage = $minMessage ?? $this->minMessage;
         $this->maxMessage = $maxMessage ?? $this->maxMessage;
+        $this->match = $match ?? $this->match;
     }
 }

Constraints/ChoiceValidator.php

@@ -65,7 +65,7 @@ public function validate(mixed $value, Constraint $constraint)
 
         if ($constraint->multiple) {
             foreach ($value as $_value) {
-                if (!\in_array($_value, $choices, true)) {
+                if ($constraint->match xor \in_array($_value, $choices, true)) {
                     $this->context->buildViolation($constraint->multipleMessage)
                         ->setParameter('{{ value }}', $this->formatValue($_value))
                         ->setParameter('{{ choices }}', $this->formatValues($choices))
@@ -98,7 +98,7 @@ public function validate(mixed $value, Constraint $constraint)
 
                 return;
             }
-        } elseif (!\in_array($value, $choices, true)) {
+        } elseif ($constraint->match xor \in_array($value, $choices, true)) {
             $this->context->buildViolation($constraint->message)
                 ->setParameter('{{ value }}', $this->formatValue($value))
                 ->setParameter('{{ choices }}', $this->formatValues($choices))

Tests/Constraints/ChoiceValidatorTest.php

@@ -343,4 +343,34 @@ public function testStrictWithMultipleChoices()
             ->setCode(Choice::NO_SUCH_CHOICE_ERROR)
             ->assertRaised();
     }
+
+    public function testMatchFalse()
+    {
+        $this->validator->validate('foo', new Choice([
+            'choices' => ['foo', 'bar'],
+            'match' => false,
+        ]));
+
+        $this->buildViolation('The value you selected is not a valid choice.')
+            ->setParameter('{{ value }}', '"foo"')
+            ->setParameter('{{ choices }}', '"foo", "bar"')
+            ->setCode(Choice::NO_SUCH_CHOICE_ERROR)
+            ->assertRaised();
+    }
+
+    public function testMatchFalseWithMultiple()
+    {
+        $this->validator->validate(['ccc', 'bar', 'zzz'], new Choice([
+            'choices' => ['foo', 'bar'],
+            'multiple' => true,
+            'match' => false,
+        ]));
+
+        $this->buildViolation('One or more of the given values is invalid.')
+            ->setParameter('{{ value }}', '"bar"')
+            ->setParameter('{{ choices }}', '"foo", "bar"')
+            ->setCode(Choice::NO_SUCH_CHOICE_ERROR)
+            ->setInvalidValue('bar')
+            ->assertRaised();
+    }
 }