[Validator] added improve support for collection validation #31196
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Validator\Constraints; | ||
|
|
||
| use Symfony\Component\Validator\Constraint; | ||
| use Symfony\Component\Validator\Exception\ConstraintDefinitionException; | ||
|
|
||
| /** | ||
| * @Annotation | ||
|
There was a problem hiding this comment. should be removed. This abstract class is not an annotation by itself. |
||
| * | ||
| * @author Marc Morales Valldepérez <marcmorales83@gmail.com> | ||
| * @author Marc Morera Merino <yuhu@mmoreram.com> | ||
| */ | ||
| abstract class AbstractComposite extends Composite | ||
| { | ||
| /** | ||
| * @var array | ||
| * | ||
| * Set of constraints | ||
| */ | ||
| public $constraints = []; | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function __construct($options = null) | ||
| { | ||
| parent::__construct($options); | ||
|
|
||
| $this->constraints = (array) $this->constraints; | ||
|
|
||
| // Each constraint contained | ||
| foreach ($this->constraints as $constraint) { | ||
| if (!$constraint instanceof Constraint) { | ||
| throw new ConstraintDefinitionException(sprintf('The value %s is not an instance of Constraint in constraint %s', $constraint, \get_class($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_class($this))); | ||
| } | ||
|
|
||
| // If explicit groups are defined | ||
| if ($this->groups != [self::DEFAULT_GROUP]) { | ||
| /* | ||
| * If constraint has explicit groups defined | ||
| * | ||
| * In that case, the groups of the nested constraint need to be | ||
| * a subset of the groups of the outer constraint. | ||
| */ | ||
| if ($constraint->groups !== [self::DEFAULT_GROUP]) { | ||
| // If are not a subset | ||
| if ($constraint->groups != array_intersect($constraint->groups, $this->groups)) { | ||
| throw new ConstraintDefinitionException(sprintf('The groups defined in Constraint %s must be a subset of the groups defined in the Constraint %s', $constraint, \get_class($this))); | ||
| } | ||
|
|
||
| // Otherwise, we add all defined groups here | ||
| } else { | ||
| foreach ($this->groups as $group) { | ||
| $constraint->addImplicitGroupName($group); | ||
| } | ||
| } | ||
|
|
||
| /* | ||
| * Otherwise, we merge current groups with constraint | ||
| */ | ||
| } else { | ||
| $this->groups = array_unique(array_merge($this->groups, $constraint->groups)); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Adds the given group if this constraint is in the Default group. | ||
| * | ||
| * Also propagate same method to nested Constraints. | ||
| * | ||
| * @param string $group | ||
| */ | ||
| public function addImplicitGroupName($group) | ||
xabbuh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| parent::addImplicitGroupName($group); | ||
|
|
||
| foreach ($this->constraints as $constraint) { | ||
| $constraint->addImplicitGroupName($group); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getDefaultOption() | ||
| { | ||
| return 'constraints'; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getRequiredOptions() | ||
| { | ||
| return ['constraints']; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function getCompositeOption() | ||
|
There was a problem hiding this comment. I do not really see why we need this method. There was a problem hiding this comment. to say if it's a contraints or a field, if we remove it, we need to remove it from the abtracts composite too and check if it's a contraints or a field |
||
| { | ||
| return 'constraints'; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Validator\Constraints; | ||
|
|
||
| /** | ||
| * @Annotation | ||
|
There was a problem hiding this comment. please also add |
||
| * | ||
| * @author Marc Morera Merino <yuhu@mmoreram.com> | ||
| * @author Marc Morales Valldepérez <marcmorales83@gmail.com> | ||
| */ | ||
| class Each extends All | ||
|
There was a problem hiding this comment. We should make the legacy annotation extend the new one instead of the opposite, so that we don't load the legacy code when you use the new annotation. |
||
| { | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Validator\Constraints; | ||
|
|
||
| /** | ||
| * @author Marc Morera Merino <yuhu@mmoreram.com> | ||
| * @author Marc Morales Valldepérez <marcmorales83@gmail.com> | ||
| * @author Hamza Amrouche <hamza.simperfit@gmail.com> | ||
| */ | ||
| class EachValidator extends AllValidator | ||
| { | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Validator\Constraints; | ||
|
|
||
| use Symfony\Component\Validator\Exception\MissingOptionsException; | ||
|
|
||
| /** | ||
| * @Annotation | ||
|
There was a problem hiding this comment. please also add |
||
| * | ||
| * @author Marc Morera Merino <yuhu@mmoreram.com> | ||
| * @author Marc Morales Valldepérez <marcmorales83@gmail.com> | ||
| */ | ||
| class Exactly extends AbstractComposite | ||
| { | ||
| /** | ||
| * @var string | ||
| * | ||
| * Message for notice Exactly Violation | ||
| */ | ||
| public $exactlyMessage = 'Exactly {{ limit }} element of this collection should pass validation.|Exactly {{ limit }} elements of this collection should pass validation.'; | ||
|
|
||
| /** | ||
| * @var int | ||
| * | ||
| * Exactly number of Success expected | ||
| */ | ||
| public $exactly; | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function __construct($options = null) | ||
| { | ||
| parent::__construct($options); | ||
| if (null === $this->exactly) { | ||
| throw new MissingOptionsException('The "exactly" option cannot be null', ['exactly']); | ||
|
There was a problem hiding this comment. why not adding it to required options instead ? It will be validated by the parent. |
||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Validator\Constraints; | ||
|
|
||
| use Symfony\Component\Validator\Constraint; | ||
| use Symfony\Component\Validator\ConstraintValidator; | ||
| use Symfony\Component\Validator\Exception\UnexpectedTypeException; | ||
| use Symfony\Component\Validator\Exception\UnexpectedValueException; | ||
|
|
||
| /** | ||
| * @author Hamza Amrouche <hamza.simperfit@gmail.com> | ||
| */ | ||
| class ExactlyValidator extends ConstraintValidator | ||
|
There was a problem hiding this comment. I am actually not convinced that we need this validator. What would be a use case for it? There was a problem hiding this comment. because of #31196 (comment) |
||
| { | ||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function validate($value, Constraint $constraint) | ||
| { | ||
| if (null === $value) { | ||
| return; | ||
| } | ||
|
|
||
| if (!$constraint instanceof Exactly) { | ||
| throw new UnexpectedTypeException($constraint, Exactly::class); | ||
| } | ||
|
|
||
| if (!is_iterable($value)) { | ||
| throw new UnexpectedValueException($value, 'array or Traversable'); | ||
| } | ||
|
|
||
| $totalIterations = \count($value) * \count($constraint->constraints); | ||
|
|
||
| $validator = $this->context->getValidator()->inContext($this->context); | ||
|
There was a problem hiding this comment. don't validate in the existing context. This will cause issues if other validators have run and have added some violations themselves. |
||
|
|
||
| foreach ($value as $key => $element) { | ||
| $validator->atPath('['.$key.']')->validate($element, $constraint->constraints); | ||
| } | ||
|
|
||
| $constraintsSuccess = $totalIterations - (int) $this->context->getViolations()->count(); | ||
| $violations = $this->context->getViolations(); | ||
| // We clear all violations as just current Validator should add real Violations | ||
| foreach ($this->context->getViolations() as $key => $violation) { | ||
| $violations->remove($key); | ||
| } | ||
|
|
||
| if (isset($constraint->exactly) && $constraintsSuccess != $constraint->exactly) { | ||
| $this->context->buildViolation($constraint->exactlyMessage) | ||
| ->setParameter('{{ limit }}', $constraint->exactly) | ||
| ->addViolation(); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest merging this line with the previous one. Adding the new constraint and its validator are a single feature addition (same for other constraints).
Older versions don't mention the validator at all btw, only the new constraint (as that's the relevant user-facing thing)