-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
[Validator] Allow using attributes to declare compile-time constraint metadata #61528
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
nicolas-grekas
merged 1 commit into
symfony:7.4
from
nicolas-grekas:validator.attribute_metadata
Sep 3, 2025
Merged
[Validator] Allow using attributes to declare compile-time constraint metadata #61528
nicolas-grekas
merged 1 commit into
symfony:7.4
from
nicolas-grekas:validator.attribute_metadata
Sep 3, 2025
Conversation
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
289783f to
8be45c5
Compare
defd051 to
ea317e8
Compare
d3490c8 to
9d08608
Compare
xabbuh
reviewed
Aug 27, 2025
src/Symfony/Component/Validator/DependencyInjection/AttributeMetadataPass.php
Show resolved
Hide resolved
3dc6ebf to
35c205e
Compare
GromNaN
reviewed
Aug 27, 2025
src/Symfony/Component/Form/Extension/Validator/Constraints/Form.php
Outdated
Show resolved
Hide resolved
src/Symfony/Component/Validator/DependencyInjection/AttributeMetadataPass.php
Outdated
Show resolved
Hide resolved
src/Symfony/Component/Validator/DependencyInjection/AttributeMetadataPass.php
Show resolved
Hide resolved
325c0c3 to
cd349b8
Compare
stof
reviewed
Aug 29, 2025
src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
Show resolved
Hide resolved
GromNaN
reviewed
Aug 29, 2025
ca89d23 to
dbe819b
Compare
dbe819b to
0197b50
Compare
GromNaN
approved these changes
Sep 3, 2025
Member
GromNaN
left a comment
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.
LGTM
nicolas-grekas
added a commit
that referenced
this pull request
Sep 3, 2025
…-time serialization metadata (nicolas-grekas) This PR was merged into the 7.4 branch. Discussion ---------- [Serializer] Allow using attributes to declare compile-time serialization metadata | Q | A | ------------- | --- | Branch? | 7.4 | Bug fix? | no | New feature? | yes | Deprecations? | yes | Issues | - | License | MIT Very close to #61528 Prerequisite for #61287 At the moment, serialization attributes are read at runtime when `framework.serialization.enable_attributes` is true. This means they don't fit for bundles nor can't they be warmed up. This PR fixes both issues by using a new `serializer.attribute_metadata` resource tag, that's turned into a list of classes to parse for attributes at compile-time. For bundles and for apps, the tag is added by explicit service configuration: ```php ->set('my_bundle.api_resource.product', Product::class) ->resourceTag('serializer.attribute_metadata') ``` Unlike validation where we have constraint attributes to auto-discover service resources, serialization doesn't have any corresponding hooks. We do have a few like `#[DiscriminatorMap]` of `#[Groups]`, but relying on those would miss many more classes that are meant for serialization. Maybe we could introduce an attribute that'd hint that some class is serializable by the component (and require the attribute at some point in the future?) Commits ------- bc6e054 [Serializer] Allow using attributes to declare compile-time serialization metadata
fabpot
added a commit
that referenced
this pull request
Sep 10, 2025
…ew constraints for a class (nicolas-grekas) This PR was merged into the 7.4 branch. Discussion ---------- [Validator] Add `#[ExtendsValidationFor]` to declare new constraints for a class | Q | A | ------------- | --- | Branch? | 7.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | - | License | MIT This PR builds on #61528 I propose to add a `#[ExtendsValidationFor]` attribute that allows adding validation constraints to another class. This is typically needed for third party classes. For context, Sylius has a nice doc about this: https://docs.sylius.com/the-customization-guide/customizing-validation At the moment, the only way to achieve this is by declaring the new constraints in the (hardcoded) `config/validation/` folder, using either xml or yaml. No attributes. With this PR, one will be able to define those extra constraints using PHP attributes, set on classes that'd mirror the properties/getters of the targeted class. The compiler pass will ensure that all properties/getters declared in these source classes also exist in the target class. (source = the app's class that declares the new constraints; target = the existing class to add constraints to.) ```php #[ExtendsValidationFor(TargetClass::class)] abstract class SourceClass { #[Assert\NotBlank(groups: ['my_app'])] #[Assert\Length(min: 3, groups: ['my_app'])] public string $name = ''; #[Assert\Email(groups: ['my_app'])] public string $email = ''; #[Assert\Range(min: 18, groups: ['my_app'])] public int $age = 0; } ``` (I made the class abstract because it's not supposed to be instantiated - but it's not mandatory.) Here are the basics of how this works: 1. During container compilation, classes marked with `#[ExtendsValidationFor(Target::class)]` are collected and validated: the container checks that members declared on the source exist on the target. If not, a `MappingException` is thrown. 2. The validator is configured to map the target to its source classes. 3. At runtime, when loading validation metadata for the target, attributes (constraints, callbacks, group providers) are read from both the target and its mapped source classes and applied accordingly. Commits ------- e884a76 [Validator] Add `#[ExtendsValidationFor]` to declare new constraints for a class
This was referenced Oct 27, 2025
Merged
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Prerequisite for #61288
At the moment, validation attributes are read at runtime when
framework.validation.enable_attributesis true.This means they don't fit for bundles nor can't they be warmed up.
This PR fixes both issues by using a new
validator.attribute_metadataresource tag, that's turned into a list of classes to parse for attributes at compile-time.For apps, the tag is added by autoconfiguration: any
Constraint-derived attributes found on a class in thesrc/folder will trigger the rule to add the tag.For bundles (and for apps if they want to), the tag is added by explicit service configuration. In an "eat your own dog-food" spirit, this capability is used to declare the constraints of the
Formclass: instead of loading thevalidation.xmlfile, we now declare this service resource:This reads the attributes added to the
Formclass:Bundles can do the same and replace their XML files by attributes.
As a next step, we could also deprecate runtime-discovery of attributes. This could be worth it if this discovery has a measurable performance impact. To be measured if one wants to dig this idea.
Side note: I'm hoping this could allow removing the yaml and xml config formats one day. For serialization metadata also (PR coming). BUT, this doesn't (yet) cover the use case of overriding metadata defined by bundles. For that, apps still have to use xml or yaml in config/validation/. I have an idea to cover this, coming to a next PR if it works.
(failures unrelated)