[Serializer] Allow to access extra infos in name converters #27021
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
ogizanagi
reviewed
Apr 23, 2018
| { | ||
| public function testImplem() | ||
| { | ||
| $p = $this->prophesize(AdvancedNameConverterInterface::class); |
There was a problem hiding this comment.
Still WIP I guess 😄
Also we don't use prophecy in symfony core test suite.
There was a problem hiding this comment.
Oops, I don't want to commit this file (yes I know for prophecy :(, it would be the perfect fit here).
5 tasks
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function normalize($propertyName, ?string $class = null, ?string $format = null, array $context = array()); |
There was a problem hiding this comment.
the ? should be removed, they are duplicate info (same below)
| * | ||
| * @author Kévin Dunglas <[email protected]> | ||
| */ | ||
| interface AdvancedNameConverterInterface extends NameConverterInterface |
There was a problem hiding this comment.
Nowhere, it's to be used in userland projects, we don't have this need in Symfony directly.
There was a problem hiding this comment.
I added a test to highlight the expected usage.
b9f10a1 to
588b68b
Compare
588b68b to
303dc63
Compare
|
conflict fixed |
fabpot
requested changes
Jul 13, 2018
| @@ -5,6 +5,7 @@ CHANGELOG | |||
| ----- | |||
|
|
|||
| * `AbstractNormalizer::handleCircularReference` is now final, and receives two optional extra arguments: the format and the context | |||
| * added `AdvancedNameConverterInterface` to access to the class, the format and the context in a name converter | |||
| namespace Symfony\Component\Serializer\NameConverter; | ||
|
|
||
| /** | ||
| * Gives access to the format and the context in the property name converters. |
303dc63 to
fe7ff09
Compare
|
@fabpot comments fixed, I'll do the doc PR. |
fabpot
approved these changes
Sep 4, 2018
fe7ff09 to
57fe017
Compare
|
Thank you @dunglas. |
fabpot
added a commit
that referenced
this pull request
Sep 4, 2018
…rters (dunglas) This PR was squashed before being merged into the 4.2-dev branch (closes #27021). Discussion ---------- [Serializer] Allow to access extra infos in name converters | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes<!-- don't forget to update src/**/CHANGELOG.md files --> | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | no <!-- don't forget to update UPGRADE-*.md and src/**/CHANGELOG.md files --> | Tests pass? | yes <!-- please add some, will be required by reviewers --> | Fixed tickets | n/a | License | MIT | Doc PR | todo Similar to #27017 and #27020 but for name converters. ping @meyerbaptiste Commits ------- 57fe017 [Serializer] Allow to access extra infos in name converters
|
I've created symfony/symfony-docs#10273 to document this new feature. Please, don't forget to create a doc issue for every new feature. Kévin, if you can't contribute the docs for this, please share some examples of this feature in action or some extended explanation. Thanks! |
javiereguiluz
added a commit
to symfony/symfony-docs
that referenced
this pull request
Sep 11, 2018
…ers (dunglas, javiereguiluz) This PR was merged into the master branch. Discussion ---------- [Serializer] Allow to access extra infos in name converters symfony/symfony#27021 Commits ------- 71afdca Minor reword ae63f8a Add a note block ca5e2e0 [Serializer] Allow to access extra infos in name converters
5 tasks
dunglas
added a commit
that referenced
this pull request
Oct 5, 2018
…properties through metadata (fbourigault) This PR was squashed before being merged into the 4.2-dev branch (closes #28505). Discussion ---------- [Serialized] allow configuring the serialized name of properties through metadata | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #15171 | License | MIT | Doc PR | symfony/symfony-docs#10422 This leverage the new `AdvancedNameConverterInterface` interface (#27021) to implement a name converter that relies on metadata. The name to use is configured per property using a `@SerializedName` annotation or the `serialized-name` XML attribute or the `serialized_name` key for YAML. This was exposed by @dunglas in #19374 (comment). # Framework integration For FramworkBundle integration, a ChainNameConverter could be added to allow users to use this name converter with a custom one. # To do - [x] add a CHANGELOG.md entry. - [x] add a fallback. - [x] add framework integration. - [x] add local caching to `MetadataAwareNameConverter`. - [x] add a doc PR. Commits ------- d1d1ceb [Serialized] allow configuring the serialized name of properties through metadata
This was referenced Nov 3, 2018
Closed
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.
Similar to #27017 and #27020 but for name converters.
ping @meyerbaptiste