Make constraint violation interfaces stringable #45484
Merged
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
|
Hey! I think @jschaedl has recently worked with this code. Maybe they can help review this? Cheers! Carsonbot |
|
What's the use case that made you open this? |
The use case is casting the errors to a string for dev messages, which should be legit according to the docs, but then static analysis tools complain, which makes sense since there's no guarantee that the implementation being use is stringable. Adding it to the interface would assure that changing the implantation wont break any code and will satisfy static analysis tools. |
5416369 to
9c9408f
Compare
|
im not sure docs should rely on a debugging-string, but rather should show a serialized constraint violation list or some manually constructed payload |
9c9408f to
91bf1b1
Compare
91bf1b1 to
4cead0c
Compare
derrabus
reviewed
Mar 8, 2022
nicolas-grekas
approved these changes
Mar 8, 2022
fabpot
approved these changes
Mar 9, 2022
|
Thank you @HypeMC. |
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.
Currently the
ConstraintViolationInterface&ConstraintViolationListInterfacedon't have a__toString()method even though their only implementations do. Since thevalidatemethod returns aConstraintViolationListInterfacetrying to cast the errors into a string doesn't sit well with static analysis tools.Here I've used an example from the docs:
This PR adds a
__toString()method to the interfaces via an@methodtag. In Symfony 7 theStringableinterface can be implemented instead.