[Validator] Introduce `BackedEnumValue` constraint #54226

AurelienPillevesse · Mar 10, 2024

Q	A
Branch?	7.3
Bug fix?	no
New feature?	yes
Deprecations?	no
Issues	-
License	MIT

My use case: I receive data in my DTOs that we only want if this value exists in an Enum and reject the whole thing at validation otherwise.

derrabus · Mar 10, 2024

Did you read the discussion on #43047?

AurelienPillevesse · Mar 10, 2024

Didn't see it before, my bad

AurelienPillevesse · Mar 10, 2024

It's a dedicated constraint so why not but I understand if your point of view is to not accept it and adding the code below (as mentioned in the other discussion) if people want to accept an Enum value with #[MapRequestPayload] for example :

public static function values(): array
{
    return array_column(self::cases(), 'value');
}

Because you are speaking about this topic, can you maybe give me feedback about this PR : symfony/symfony-docs#19590 (if it's added in the documentation, we will probably less try to find a way to achieve it)

derrabus · Mar 10, 2024

I understand if your point of view is to not accept it

I didn't say that. It's just that there has been a PR on that topic a while ago, and if we revisit the topic, we should take that prior discussion into account.

src/Symfony/Component/Validator/ConstraintValidator.php

src/Symfony/Component/Validator/Constraints/Enum.php

src/Symfony/Component/Validator/Constraints/EnumValidator.php

src/Symfony/Component/Validator/Tests/Constraints/EnumValidatorTest.php

src/Symfony/Component/Validator/CHANGELOG.md

src/Symfony/Component/Validator/Constraints/BackedEnumValueValidator.php

src/Symfony/Component/Validator/Constraints/BackedEnumValue.php

src/Symfony/Component/Validator/Constraints/BackedEnumValueValidator.php

src/Symfony/Component/Validator/Constraints/BackedEnumValue.php

src/Symfony/Component/Validator/Constraints/BackedEnumValueValidator.php

src/Symfony/Component/Validator/Constraints/BackedEnumValue.php

src/Symfony/Component/Validator/Constraints/BackedEnumValueValidator.php

src/Symfony/Component/Validator/Tests/Constraints/BackedEnumValueValidatorTest.php

src/Symfony/Component/Validator/Constraints/BackedEnumValueValidator.php

src/Symfony/Component/Validator/Constraints/BackedEnumValue.php

AurelienPillevesse · Dec 12, 2024

@fabpot @nicolas-grekas
When I add my line in the changelog, it's telling me that I've a conflict.
If I'm fixing the conflict with github UI, the conflict is solved but it merge the branch 7.3 and fabbot is not happy

Can you tell me how to handle it properly?

stof · Dec 12, 2024

@AurelienPillevesse you should rebase your branch on top of the latest upstream 7.3 branch instead of merging. See https://symfony.com/doc/current/contributing/code/pull_requests.html#rebase-your-pull-request for the detailed explanation.

AurelienPillevesse · Dec 15, 2024

Thanks @stof

mtarld · Dec 16, 2024

src/Symfony/Component/Validator/Constraints/BackedEnumValue.php

+        parent::__construct([], $groups, $payload);
+
+        if (!is_a($type, \BackedEnum::class, true)) {
+            throw new ConstraintDefinitionException(\sprintf('The "type" must be a \BackedEnum, got "%s".', get_debug_type($type)));


Suggested change

throw new ConstraintDefinitionException(\sprintf('The "type" must be a \BackedEnum, got "%s".', get_debug_type($type)));

throw new ConstraintDefinitionException(\sprintf('The "type" must be a "\BackedEnum", got "%s".', get_debug_type($type)));

src/Symfony/Component/Validator/Constraints/BackedEnumValue.php

mtarld · Dec 16, 2024

src/Symfony/Component/Validator/Constraints/BackedEnumValue.php

+    ) {
+        parent::__construct([], $groups, $payload);
+
+        if (!is_a($type, \BackedEnum::class, true)) {


Suggested change

if (!is_a($type, \BackedEnum::class, true)) {

if (!is_subclass_of($type, \BackedEnum::class, true)) {

is_a() looks okay to me?

mtarld · Dec 16, 2024

src/Symfony/Component/Validator/Constraints/BackedEnumValue.php

+    ];
+
+    /**
+     * @param class-string<\BackedEnum> $type   the type of the enum


Suggested change

* @param class-string<\BackedEnum> $type the type of the enum

* @param class-string<\BackedEnum> $className the enum class name

first letter should be uppercase also

mtarld · Dec 16, 2024

src/Symfony/Component/Validator/Constraints/BackedEnumValue.php

+        public string $type,
+        public array $except = [],
+        public string $message = 'The value you selected is not a valid choice.',
+        public string $typeMessage = 'This value should be of type {{ type }}.',


Suggested change

public string $typeMessage = 'This value should be of type {{ type }}.',

public string $invalidValueTypeMessage = 'The value should be of type {{ type }}.',

mtarld · Dec 16, 2024

src/Symfony/Component/Validator/Constraints/BackedEnumValue.php

+    public function __construct(
+        public string $type,
+        public array $except = [],
+        public string $message = 'The value you selected is not a valid choice.',


Suggested change

public string $message = 'The value you selected is not a valid choice.',

public string $invalidValueMessage = 'The value is not a backing value of {{ className }}.',

mtarld · Dec 16, 2024

src/Symfony/Component/Validator/Constraints/BackedEnumValueValidator.php

+                ->setParameter('{{ value }}', $this->formatValue($value))
+                ->setParameter('{{ choices }}', $this->formatValidCases($constraint))


@derrabus is right, you only need to define what is in the constraint message

It's build in a similar way as Choice constraint.

Message :

symfony/src/Symfony/Component/Validator/Constraints/Choice.php

Line 41 in 78f4d9a

public string $message = 'The value you selected is not a valid choice.';

Validator :

symfony/src/Symfony/Component/Validator/Constraints/ChoiceValidator.php

Lines 101 to 105 in 78f4d9a

$this->context->buildViolation($constraint->message)

->setParameter('{{ value }}', $this->formatValue($value))

->setParameter('{{ choices }}', $this->formatValues($choices))

->setCode(Choice::NO_SUCH_CHOICE_ERROR)

->addViolation();

The value or choice values are not used by default. If you override the default message and use {{ value }} or {{ choice }} on it, it will be replaced in your new message.

mtarld · Dec 16, 2024

src/Symfony/Component/Validator/Constraints/BackedEnumValueValidator.php

+        }
+
+        try {
+            $enumTypeValue = $constraint->type::tryFrom($value);


Suggested change

$enumTypeValue = $constraint->type::tryFrom($value);

$enumValue = $constraint->type::tryFrom($value);

mtarld · Dec 16, 2024

src/Symfony/Component/Validator/Constraints/BackedEnumValueValidator.php

+        return $this->formatValues(array_map(
+            static fn (\BackedEnum $case) => $case->value,
+            array_filter(
+                $constraint->type::cases(),
+                static fn (\BackedEnum $currentValue) => !\in_array($currentValue, $constraint->except, true),
+            )
+        ));


Suggested change

return $this->formatValues(array_map(

static fn (\BackedEnum $case) => $case->value,

array_filter(

$constraint->type::cases(),

static fn (\BackedEnum $currentValue) => !\in_array($currentValue, $constraint->except, true),

)

));

return $this->formatValues(array_column(

array_filter(

$constraint->type::cases(),

static fn (\BackedEnum $currentValue) => !\in_array($currentValue, $constraint->except, true),

),

'value',

));

sfmok · Dec 19, 2024

I think this change requires setting ALLOW_INVALID_VALUES to true by default in

symfony/src/Symfony/Component/Serializer/Normalizer/BackedEnumNormalizer.php

Line 59 in 0a9eb28

if ($context[self::ALLOW_INVALID_VALUES] ?? false) {

Otherwise, a typical use of this validator in APIs will throw a NotNormalizableValueException unless ALLOW_INVALID_VALUES is explicitly set to true in the context, which does not make sense IMO.

stof · Jan 28, 2025

@sfmok this PR is totally unrelated to that normalizer. The constraint added here is meant to be used in case your DTO expects a scalar value that must match the value associated with a case of the backed enum. The BackedEnumNormalizer is triggered in case the DTO expects a BackedEnum instance.

thePanz · Mar 6, 2025

Thanks for pointing that out @stof and @sfmok : we should make it clean from the docs that the case is the following:

class MyDto {
    #[Assert\BackedEnumValue(MyStringBackedEnum::class)]
    public string $value = null;
}

carsonbot added Status: Needs Review Feature RFC RFC = Request For Comments (proposals about features that you want to be discussed) Validator labels Mar 10, 2024

carsonbot added this to the 7.1 milestone Mar 10, 2024

carsonbot changed the title ~~[RFC][Validator] Introduce Enum constraint~~ [Validator] Introduce Enum constraint Mar 10, 2024

AurelienPillevesse changed the title ~~[Validator] Introduce Enum constraint~~ [Validator] Introduce Enum constraint Mar 10, 2024

derrabus requested changes Mar 10, 2024

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Mar 10, 2024

derrabus reviewed Mar 11, 2024

View reviewed changes

src/Symfony/Component/Validator/CHANGELOG.md Outdated Show resolved Hide resolved

stof reviewed Mar 11, 2024

View reviewed changes

src/Symfony/Component/Validator/Constraints/BackedEnumValueValidator.php Outdated Show resolved Hide resolved

src/Symfony/Component/Validator/Constraints/BackedEnumValue.php Outdated Show resolved Hide resolved

AurelienPillevesse requested a review from derrabus March 11, 2024 21:14

carsonbot added Status: Needs Review and removed Status: Needs Work labels Mar 11, 2024

AurelienPillevesse requested a review from stof March 11, 2024 21:14

AurelienPillevesse changed the title ~~[Validator] Introduce Enum constraint~~ [Validator] Introduce BackedEnumValue constraint Mar 11, 2024

derrabus requested changes Mar 11, 2024

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Mar 11, 2024

AurelienPillevesse requested a review from derrabus March 12, 2024 08:13

carsonbot added Status: Needs Review and removed Status: Needs Work labels Mar 12, 2024

derrabus reviewed Mar 12, 2024

View reviewed changes

src/Symfony/Component/Validator/Constraints/BackedEnumValueValidator.php Outdated Show resolved Hide resolved

derrabus reviewed Mar 12, 2024

View reviewed changes

src/Symfony/Component/Validator/Tests/Constraints/BackedEnumValueValidatorTest.php Outdated Show resolved Hide resolved

src/Symfony/Component/Validator/Constraints/BackedEnumValueValidator.php Outdated Show resolved Hide resolved

AurelienPillevesse requested a review from derrabus March 12, 2024 12:06

AurelienPillevesse requested a review from xabbuh August 18, 2024 15:49

carsonbot added Status: Needs Review and removed Status: Reviewed labels Aug 18, 2024

AurelienPillevesse requested a review from OskarStark August 18, 2024 15:49

xabbuh reviewed Aug 19, 2024

View reviewed changes

src/Symfony/Component/Validator/Constraints/BackedEnumValue.php Outdated Show resolved Hide resolved

xabbuh reviewed Aug 19, 2024

View reviewed changes

src/Symfony/Component/Validator/Constraints/BackedEnumValue.php Outdated Show resolved Hide resolved

AurelienPillevesse requested a review from xabbuh August 19, 2024 13:33

fabpot modified the milestones: 7.2, 7.3 Nov 20, 2024

AurelienPillevesse force-pushed the introduce-enum-constraint branch 4 times, most recently from e48670d to edf0705 Compare December 10, 2024 19:04

AurelienPillevesse force-pushed the introduce-enum-constraint branch from d03a838 to edf0705 Compare December 15, 2024 15:03

AurelienPillevesse added 3 commits December 15, 2024 16:11

introduce Enum constraint

eba7091

fix cs fix

c409057

add assert exception message

fb3fcd2

AurelienPillevesse force-pushed the introduce-enum-constraint branch from edf0705 to fb3fcd2 Compare December 15, 2024 15:20

AurelienPillevesse added 2 commits December 15, 2024 16:25

update changelog

ef6dedc

update changelog

ca72503

AurelienPillevesse requested a review from chalasr December 15, 2024 15:32

mtarld reviewed Dec 16, 2024

View reviewed changes

derrabus mentioned this pull request Jan 28, 2025

[Validator] Add support for enum in Choice constraint #59633

Closed

hmeneuvrier mentioned this pull request Feb 11, 2025

[API] Ajout de documents MTES-MCT/histologe#3682

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Validator] Introduce `BackedEnumValue` constraint #54226

[Validator] Introduce `BackedEnumValue` constraint #54226

AurelienPillevesse commented Mar 10, 2024 •

edited

Loading

derrabus commented Mar 10, 2024

AurelienPillevesse commented Mar 10, 2024

AurelienPillevesse commented Mar 10, 2024

derrabus commented Mar 10, 2024

AurelienPillevesse commented Dec 12, 2024 •

edited

Loading

stof commented Dec 12, 2024

AurelienPillevesse commented Dec 15, 2024

mtarld Dec 16, 2024

mtarld Dec 16, 2024

derrabus Mar 30, 2025

mtarld Dec 16, 2024

chalasr Mar 29, 2025

mtarld Dec 16, 2024

mtarld Dec 16, 2024

mtarld Dec 16, 2024

AurelienPillevesse Dec 24, 2024 •

edited

Loading

mtarld Dec 16, 2024

mtarld Dec 16, 2024

sfmok commented Dec 19, 2024

stof commented Jan 28, 2025

thePanz commented Mar 6, 2025

	throw new ConstraintDefinitionException(\sprintf('The "type" must be a \BackedEnum, got "%s".', get_debug_type($type)));
	throw new ConstraintDefinitionException(\sprintf('The "type" must be a "\BackedEnum", got "%s".', get_debug_type($type)));

	if (!is_a($type, \BackedEnum::class, true)) {
	if (!is_subclass_of($type, \BackedEnum::class, true)) {

	* @param class-string<\BackedEnum> $type the type of the enum
	* @param class-string<\BackedEnum> $className the enum class name

	public string $typeMessage = 'This value should be of type {{ type }}.',
	public string $invalidValueTypeMessage = 'The value should be of type {{ type }}.',

	public string $message = 'The value you selected is not a valid choice.',
	public string $invalidValueMessage = 'The value is not a backing value of {{ className }}.',

		->setParameter('{{ value }}', $this->formatValue($value))
		->setParameter('{{ choices }}', $this->formatValidCases($constraint))

	$this->context->buildViolation($constraint->message)
	->setParameter('{{ value }}', $this->formatValue($value))
	->setParameter('{{ choices }}', $this->formatValues($choices))
	->setCode(Choice::NO_SUCH_CHOICE_ERROR)
	->addViolation();

	$enumTypeValue = $constraint->type::tryFrom($value);
	$enumValue = $constraint->type::tryFrom($value);

Search code, repositories, users, issues, pull requests...

[Validator] Introduce BackedEnumValue constraint #54226

Are you sure you want to change the base?

[Validator] Introduce BackedEnumValue constraint #54226

Conversation

AurelienPillevesse commented Mar 10, 2024 • edited Loading

derrabus commented Mar 10, 2024

AurelienPillevesse commented Mar 10, 2024

AurelienPillevesse commented Mar 10, 2024

derrabus commented Mar 10, 2024

AurelienPillevesse commented Dec 12, 2024 • edited Loading

stof commented Dec 12, 2024

AurelienPillevesse commented Dec 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AurelienPillevesse Dec 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sfmok commented Dec 19, 2024

stof commented Jan 28, 2025

thePanz commented Mar 6, 2025

[Validator] Introduce `BackedEnumValue` constraint #54226

[Validator] Introduce `BackedEnumValue` constraint #54226

AurelienPillevesse commented Mar 10, 2024 •

edited

Loading

AurelienPillevesse commented Dec 12, 2024 •

edited

Loading

AurelienPillevesse Dec 24, 2024 •

edited

Loading