[Validator] Target aware class constraints #16978
10000
Next
Next commit
[Validator] Target aware constraint's interface and trait
- Loading branch information
commit ef2bad61bfadd3470ef69d617ceefdfbb7bf9021
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 |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| <?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; | ||
|
|
||
| /** | ||
| * This interface is to be implemented by constraints that need to be | ||
| * aware of the exact target they have been declared on. | ||
| * | ||
| * This interface only makes sense for class constraints. Which could be | ||
| * attached to multiple classes because of class inheritance. | ||
| * | ||
| * @since 3.1 | ||
| * | ||
| * @author Mathieu Lemoine <mlemoine@mlemoine.name> | ||
| */ | ||
| interface TargetAwareConstraintInterface | ||
| { | ||
| /* | ||
| * Since constraints are implemented using public properties, | ||
| * the interface is intended as a tag and declare no method. | ||
| */ | ||
| } |
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,37 @@ | ||
| <?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; | ||
|
|
||
| /** | ||
| * This trait is intended as a helper for implementing TargetAwareConstraintInterface. | ||
| * | ||
| * Since the interface interface only makes sense for class constraints, | ||
| * the default targets is set to class constraint. | ||
| * | ||
| * @since 3.1 | ||
| * | ||
| * @author Mathieu Lemoine <mlemoine@mlemoine.name> | ||
| */ | ||
| trait TargetAwareConstraintTrait | ||
| { | ||
| public $target; | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getTargets() | ||
| { | ||
| return Constraint::CLASS_CONSTRAINT; | ||
| } | ||
| } | ||
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.
Just wondering: Why don't you think it could be useful for property constraints ?
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 see target awareness like a scope widening feature.
So called class constraints are lexically applied to the class but usually have the validated instance as their scope (i.e. The constraint is checking that the current instance respects such and such invariant). A TA class constraint is using the class as its scope (i.e. The constraint is checking that the current instance does not break such and such invariant among all the other instances of the class).
Following the same reasoning, property constraints have the validated property as their scope (i.e. The constraint is checking that the current property respects such and such invariant). Widening the scope of such constraint to the current instance is already possible using a class constraint (with a custom path).