[Validator] remove support for generic constraint option handling #61063

xabbuh · 2025-07-08T06:52:59Z

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

opening the PR already even if some polishing needs to be done (and not all tests pass yet) to avoid someone else wasting their time on this topic

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

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

stof · 2025-07-08T10:40:11Z

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

@@ -32,7 +32,7 @@ public function __construct(mixed $options = null, ?array $groups = null, mixed
            throw new ConstraintDefinitionException(\sprintf('You can\'t redefine the "%s" option. Use the "%s::getConstraints()" method instead.', $this->getCompositeOption(), __CLASS__));
        }

-        $this->constraints = $this->getConstraints($this->normalizeOptions($options));
+        $this->constraints = $this->getConstraints($options ?? []);


We probably need to deprecate using options in this Compound abstract class first, to be able to remove support properly.

Indeed, that's not a really useful feature anymore. I'm gonna send a PR for the deprecation targeting the 7.4 branch.

stof · 2025-07-08T10:41:31Z

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

-    public function getDefaultOption(): ?string
-    {
-        return 'constraints';
+        parent::__construct(null, $groups, $payload);
    }

    protected function getCompositeOption(): string


this method should also be removed, as it does not make sense anymore once the parent does not handle an array of options anymore.

getCompositeOption() is used independently from the $options array in the constructor of the Composite base class:

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

Lines 64 to 115 in b49a855

foreach ((array) $this->getCompositeOption() as $option) {

/** @var Constraint[] $nestedConstraints */

$nestedConstraints = $this->$option;

if (!\is_array($nestedConstraints)) {

$nestedConstraints = [$nestedConstraints];

}

foreach ($nestedConstraints as $constraint) {

if (!$constraint instanceof Constraint) {

if (\is_object($constraint)) {

$constraint = get_debug_type($constraint);

}

throw new ConstraintDefinitionException(\sprintf('The value "%s" is not an instance of Constraint in constraint "%s".', $constraint, get_debug_type($this)));

}

if ($constraint instanceof Valid) {

throw new ConstraintDefinitionException(\sprintf('The constraint Valid cannot be nested inside constraint "%s". You can only declare the Valid constraint directly on a field or method.', get_debug_type($this)));

}

}

if (!isset(((array) $this)['groups'])) {

$mergedGroups = [];

foreach ($nestedConstraints as $constraint) {

foreach ($constraint->groups as $group) {

$mergedGroups[$group] = true;

}

}

// prevent empty composite constraint to have empty groups

$this->groups = array_keys($mergedGroups) ?: [self::DEFAULT_GROUP];

$this->$option = $nestedConstraints;

continue;

}

foreach ($nestedConstraints as $constraint) {

if (isset(((array) $constraint)['groups'])) {

$excessGroups = array_diff($constraint->groups, $this->groups);

if (\count($excessGroups) > 0) {

throw new ConstraintDefinitionException(\sprintf('The group(s) "%s" passed to the constraint "%s" should also be passed to its containing constraint "%s".', implode('", "', $excessGroups), get_debug_type($constraint), get_debug_type($this)));

}

} else {

$constraint->groups = $this->groups;

}

}

$this->$option = $nestedConstraints;

}

The important part when not being able anymore to use the options array is that the property/properties referenced with getCompositeOption() are initialised in child class before the base constructor is called (that's part of the upgrade/changelog files).

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

xabbuh · 2025-07-24T06:26:25Z

This is ready to be reviewed.

Status: Needs Review

nicolas-grekas

Wow, such nice diff! Thanks for working on this!

nicolas-grekas · 2025-07-24T08:34:03Z

UPGRADE-8.0.md

+       public $option2;
+
+       #[HasNamedArguments]
+       public function __construct($option1 = null, $option2 = null, ?array $groups = null, mixed $payload = null)


should we propose CPP here?

good idea, done

nicolas-grekas · 2025-07-24T08:34:48Z

UPGRADE-8.0.md

+           parent::__construct(null, $groups, $payload);
+       }
+   }
+   ```
 * Remove `Bic::INVALID_BANK_CODE_ERROR` constant. This error code was not used in the Bic constraint validator anymore.


no trailing dot anywhere ;)

nicolas-grekas · 2025-07-24T08:35:16Z

UPGRADE-8.0.md

+       public $option1;
+       public $option2;
+
+       #[HasNamedArguments]


do we still need this?

indeed no, fixed

nicolas-grekas · 2025-07-24T08:39:26Z

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

@@ -41,11 +41,7 @@ class Date extends Constraint
    #[HasNamedArguments]
    public function __construct(?array $options = null, ?string $message = null, ?array $groups = null, mixed $payload = null)
    {
-        if (\is_array($options)) {
-            trigger_deprecation('symfony/validator', '7.3', 'Passing an array of options to configure the "%s" constraint is deprecated, use named arguments instead.', static::class);


in cases like this, we still have a legacy $options argument
would it make sense to try to remove it, using some BC layer?
or should we throw to be sure passing anything else than null is forbidden?

We cannot easily detect if options are passed when changing the order of arguments in 7.4 (we can try again in 8.1). But I added checks for $options to be null and throw otherwise.

nicolas-grekas · 2025-07-24T08:42:16Z

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

-        $this->maxRatio = $maxRatio ?? $this->maxRatio;
-        $this->minRatio = $minRatio ?? $this->minRatio;
-        $this->minPixels = $minPixels ?? $this->minPixels;
-        $this->maxPixels = $maxPixels ?? $this->maxPixels;


we don't really have a deprecation layer for this change, do we?

We do, all these properties could only have been non null before if any of the properties were passed through the $options array.

nicolas-grekas · 2025-07-24T08:43:45Z

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

@@ -26,38 +25,16 @@ class Traverse extends Constraint
    public bool $traverse = true;

    /**
-     * @param bool|array<string,mixed>|null $traverse Whether to traverse the given object or not (defaults to true). Pass an associative array to configure the constraint's options (e.g. payload).


could be worth doing this on 7.4: docblocks should be only about the non-deprecated API

carsonbot added Status: Needs Work Feature Validator labels Jul 8, 2025

carsonbot added this to the 8.0 milestone Jul 8, 2025

carsonbot changed the title ~~[WIP][Validator] remove support for generic constraint option handling~~ [Validator] [WIP] remove support for generic constraint option handling Jul 8, 2025

xabbuh force-pushed the validator-cleanup branch from 95fd8a0 to d04270c Compare July 8, 2025 06:58

xabbuh requested a review from chalasr as a code owner July 8, 2025 06:58

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jul 8, 2025

xabbuh force-pushed the validator-cleanup branch 2 times, most recently from b8ba9e7 to 0c03730 Compare July 8, 2025 09:25

stof reviewed Jul 8, 2025

View reviewed changes

xabbuh mentioned this pull request Jul 11, 2025

[Validator] Remove deprecated Expression methods #61104

Closed

xabbuh force-pushed the validator-cleanup branch 2 times, most recently from 5428b30 to e934b07 Compare July 11, 2025 18:34

alexandre-daubois added the BC Layer removal Used to track BC layer removals before a major release label Jul 11, 2025

xabbuh force-pushed the validator-cleanup branch 5 times, most recently from 71a8b66 to 8397d33 Compare July 16, 2025 13:37

xabbuh force-pushed the validator-cleanup branch 5 times, most recently from 17fcad8 to 9df2c71 Compare July 24, 2025 06:03

xabbuh changed the title ~~[Validator] [WIP] remove support for generic constraint option handling~~ [Validator] remove support for generic constraint option handling Jul 24, 2025

nicolas-grekas reviewed Jul 24, 2025

View reviewed changes

xabbuh force-pushed the validator-cleanup branch from 9df2c71 to 28644a9 Compare July 25, 2025 20:27

remove support for generic constraint option handling

f70d261

xabbuh force-pushed the validator-cleanup branch from 28644a9 to f70d261 Compare July 25, 2025 20:49

xabbuh mentioned this pull request Jul 25, 2025

[Validator] remove docblocks for deprecated argument types #61240

Merged

fabpot closed this in da5988e Jul 26, 2025

xabbuh reopened this Jul 26, 2025

	foreach ((array) $this->getCompositeOption() as $option) {
	/** @var Constraint[] $nestedConstraints */
	$nestedConstraints = $this->$option;

	if (!\is_array($nestedConstraints)) {
	$nestedConstraints = [$nestedConstraints];
	}

	foreach ($nestedConstraints as $constraint) {
	if (!$constraint instanceof Constraint) {
	if (\is_object($constraint)) {
	$constraint = get_debug_type($constraint);
	}

	throw new ConstraintDefinitionException(\sprintf('The value "%s" is not an instance of Constraint in constraint "%s".', $constraint, get_debug_type($this)));
	}

	if ($constraint instanceof Valid) {
	throw new ConstraintDefinitionException(\sprintf('The constraint Valid cannot be nested inside constraint "%s". You can only declare the Valid constraint directly on a field or method.', get_debug_type($this)));
	}
	}

	if (!isset(((array) $this)['groups'])) {
	$mergedGroups = [];

	foreach ($nestedConstraints as $constraint) {
	foreach ($constraint->groups as $group) {
	$mergedGroups[$group] = true;
	}
	}

	// prevent empty composite constraint to have empty groups
	$this->groups = array_keys($mergedGroups) ?: [self::DEFAULT_GROUP];
	$this->$option = $nestedConstraints;

	continue;
	}

	foreach ($nestedConstraints as $constraint) {
	if (isset(((array) $constraint)['groups'])) {
	$excessGroups = array_diff($constraint->groups, $this->groups);

	if (\count($excessGroups) > 0) {
	throw new ConstraintDefinitionException(\sprintf('The group(s) "%s" passed to the constraint "%s" should also be passed to its containing constraint "%s".', implode('", "', $excessGroups), get_debug_type($constraint), get_debug_type($this)));
	}
	} else {
	$constraint->groups = $this->groups;
	}
	}

	$this->$option = $nestedConstraints;
	}

Uh oh!

[Validator] remove support for generic constraint option handling #61063

Are you sure you want to change the base?

[Validator] remove support for generic constraint option handling #61063

Conversation

xabbuh commented Jul 8, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

xabbuh commented Jul 24, 2025

Uh oh!

nicolas-grekas left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

nicolas-grekas Jul 24, 2025 •

edited

Loading