[Serializer] Rename normalize param #39735
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
dunglas
approved these changes
Jan 12, 2021
dunglas
reviewed
Jan 12, 2021
| { | ||
| if (!$object instanceof FlattenException) { |
There was a problem hiding this comment.
Maybe could you just add a @param tag here to make Psalm happy?
There was a problem hiding this comment.
I can remove these lines if preferred ; this does not have impact psalm for developer which extends this class.
My main concern was about the name of the param.
This method is public, and the interface is allowing object ; so theorically this method should handle every possible object and not restricting the param directly in the phpdoc.
I agree that this seems duplicate with the supportNormalization method. We could consider that this is similar to Voter
But when I look at others Normalizer, it seems that checking the param was the strategy adopted
- https://github.com/symfony/symfony/blob/5.x/src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php#L53
- https://github.com/symfony/symfony/blob/5.x/src/Symfony/Component/Serializer/Normalizer/ArrayDenormalizer.php#L42
- https://github.com/symfony/symfony/blob/5.x/src/Symfony/Component/Serializer/Normalizer/JsonSerializableNormalizer.php#L33
- https://github.com/symfony/symfony/blob/5.x/src/Symfony/Component/Serializer/Normalizer/DataUriNormalizer.php#L55
So I added consistency
fabpot
approved these changes
Jan 13, 2021
|
Thank you @VincentLanglet. |
This was referenced Jan 27, 2021
Merged
Merged
Merged
hultberg
pushed a commit
to hultberg/symfony
that referenced
this pull request
Sep 17, 2021
This PR was merged into the 4.4 branch. Discussion ---------- [Serializer] Rename normalize param | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | License | MIT The ProblemNormalizer is the only one Normalizer which - Use a different param name `$exception` instead of the one in the interface `$object`. - Doesn't type check the param. The first point lead to an unfixable error with Psalm when extending the ProblemNormalizer - If the variable is named `$object` it does not match with the parent - If the variable is named `$exception` it does not match with the interface Commits ------- 7e6eee2 Rename normalize param
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.
The ProblemNormalizer is the only one Normalizer which
$exceptioninstead of the one in the interface$object.The first point lead to an unfixable error with Psalm when extending the ProblemNormalizer
$objectit does not match with the parent$exceptionit does not match with the interface