[Validator] New NodeTraverser implementation #10287
[Validator] Completed GroupSequence implementation
- Loading branch information
commit 8318286650b6ac220b64ffec2ac1ea67fff1d0f9
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,10 +11,44 @@ | |
|
|
||
| namespace Symfony\Component\Validator\Constraints; | ||
|
|
||
| use Symfony\Component\Validator\Exception\OutOfBoundsException; | ||
| use Traversable; | ||
|
|
||
| /** | ||
| * A sequence of validation groups. | ||
| * | ||
| * When validating a group sequence, each group will only be validated if all | ||
| * of the previous groups in the sequence succeeded. For example: | ||
| * | ||
| * $validator->validateObject($address, new GroupSequence('Basic', 'Strict')); | ||
| * | ||
| * In the first step, all constraints that belong to the group "Basic" will be | ||
| * validated. If none of the constraints fail, the validator will then validate | ||
| * the constraints in group "Strict". This is useful, for example, if "Strict" | ||
| * contains expensive checks that require a lot of CPU or slow, external | ||
| * services. You usually don't want to run expensive checks if any of the cheap | ||
| * checks fails. | ||
| * | ||
| * When adding metadata to a class, you can override the "Default" group of | ||
| * that class with a group sequence: | ||
| * | ||
| * /** | ||
| * * @GroupSequence({"Address", "Strict"}) | ||
| * *\/ | ||
| * class Address | ||
| * { | ||
| * // ... | ||
| * } | ||
| * | ||
| * Whenever you validate that object in the "Default" group, the group sequence | ||
| * will be validated: | ||
|
There was a problem hiding this comment. This point was, and stays a bit hard to understand.
I want to highlight a naming issue here. In the past, I was a bit lost between There was a problem hiding this comment. I know, this is one of the confusing parts of JSR-303. Suppose you have constraints in the "Default" group: class Address
{
/**
* @Length(min=3, groups="Default")
*/
private $street;
}Then these two calls will be 100% equivalent: $violations = $validator->validate($address, "Default");
$violations = $validator->validate($address, "Address");We say that "Address" is the implicit group name of those constraints, i.e. a group name that is equivalent to "Default". Let's override the default group with a sequence: /**
* @GroupSequence({"Address", "Strict"})
*/
class Address
{
// ... rest stays the same ...
}Now the calls are not equivalent anymore: // validates the group sequence
$violations = $validator->validate($address, "Default");
// validates the constraints in "Default"
$violations = $validator->validate($address, "Address");That is also why you need to refer to the "Default" group as "" in the sequence. The following would create a recursion and is invalid (remember that "Default" === the group sequence now): /**
* @GroupSequence({"Default", "Strict"})
*/
class Address
{
// ... rest stays the same ...
}There was a problem hiding this comment. Btw, if you think you can improve the documentation about this functionality, please with sugar on top do so :) There was a problem hiding this comment. Ok understood. Thanks. I think we can copy/paste your explanation for the doc. ping @wouterj There was a problem hiding this comment. |
||
| * | ||
| * $validator->validateObject($address); | ||
| * | ||
| * If you want to execute the constraints of the "Default" group for a class | ||
| * with an overridden default group, pass the class name as group name instead: | ||
| * | ||
| * $validator->validateObject($address, "Address") | ||
| * | ||
| * @Annotation | ||
| * | ||
|
|
@@ -25,13 +59,14 @@ | |
| class GroupSequence implements \ArrayAccess, \IteratorAggregate, \Countable | ||
| { | ||
| /** | ||
| * The groups in the sequence | ||
| * | ||
| * @var string[]|GroupSequence[] | ||
| */ | ||
| public $groups; | ||
|
|
||
| /** | ||
| * The group in which cascaded objects are validated when validating | ||
| * this sequence. | ||
| * | ||
| * By default, cascaded objects are validated in each of the groups of | ||
|
|
@@ -46,27 +81,80 @@ class GroupSequence implements \ArrayAccess, \IteratorAggregate, \Countable | |
| */ | ||
| public $cascadedGroup; | ||
|
|
||
| /** | ||
| * Creates a new group sequence. | ||
| * | ||
| * @param string[] $groups The groups in the sequence | ||
| */ | ||
| public function __construct(array $groups) | ||
| { | ||
| // Support for Doctrine annotations | ||
| $this->groups = isset($groups['value']) ? $groups['value'] : $groups; | ||
| } | ||
|
|
||
| /** | ||
| * Returns an iterator for this group. | ||
| * | ||
| * @return Traversable The iterator | ||
| * | ||
| * @see \IteratorAggregate::getIterator() | ||
| * | ||
| * @deprecated Implemented for backwards compatibility. To be removed in | ||
| * Symfony 3.0. | ||
| */ | ||
| public function getIterator() | ||
| { | ||
| return new \ArrayIterator($this->groups); | ||
| } | ||
|
|
||
| /** | ||
| * Returns whether the given offset exists in the sequence. | ||
| * | ||
| * @param integer $offset The offset | ||
| * | ||
| * @return Boolean Whether the offset exists | ||
| * | ||
| * @deprecated Implemented for backwards compatibility. To be removed in | ||
| * Symfony 3.0. | ||
| */ | ||
| public function offsetExists($offset) | ||
| { | ||
| return isset($this->groups[$offset]); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the group at the given offset. | ||
| * | ||
| * @param integer $offset The offset | ||
| * | ||
| * @return string The group a the given offset | ||
| * | ||
| * @throws OutOfBoundsException If the object does not exist | ||
| * | ||
| * @deprecated Implemented for backwards compatibility. To be removed in | ||
| * Symfony 3.0. | ||
| */ | ||
| public function offsetGet($offset) | ||
| { | ||
| if (!isset($this->groups[$offset])) { | ||
| throw new OutOfBoundsException(sprintf( | ||
| 'The offset "%s" does not exist.', | ||
| $offset | ||
| )); | ||
| } | ||
|
|
||
| return $this->groups[$offset]; | ||
|
There was a problem hiding this comment. you need to take care of error handling here to avoid a notice on invalid access There was a problem hiding this comment.
:) |
||
| } | ||
|
|
||
| /** | ||
| * Sets the group at the given offset. | ||
| * | ||
| * @param integer $offset The offset | ||
| * @param string $value The group name | ||
| * | ||
| * @deprecated Implemented for backwards compatibility. To be removed in | ||
| * Symfony 3.0. | ||
| */ | ||
| public function offsetSet($offset, $value) | ||
| { | ||
| if (null !== $offset) { | ||
|
|
@@ -78,11 +166,27 @@ public function offsetSet($offset, $value) | |
| $this->groups[] = $value; | ||
| } | ||
|
|
||
| /** | ||
| * Removes the group at the given offset. | ||
| * | ||
| * @param integer $offset The offset | ||
| * | ||
| * @deprecated Implemented for backwards compatibility. To be removed in | ||
| * Symfony 3.0. | ||
| */ | ||
| public function offsetUnset($offset) | ||
| { | ||
| unset($this->groups[$offset]); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the number of groups in the sequence. | ||
| * | ||
| * @return integer The number of groups | ||
| * | ||
| * @deprecated Implemented for backwards compatibility. To be removed in | ||
| * Symfony 3.0. | ||
| */ | ||
| public function count() | ||
| { | ||
| return count($this->groups); | ||
|
|
||
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\Exception; | ||
|
|
||
| /** | ||
| * Base OutOfBoundsException for the Validator component. | ||
| * | ||
| * @author Bernhard Schussek <bschussek@gmail.com> | ||
| */ | ||
| class OutOfBoundsException extends \OutOfBoundsException implements ExceptionInterface | ||
| { | ||
| } |
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
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.
failas any is plural right?