[Serializer] Add options to JsonDecode and JsonEncode to wrap/unwrap json data #28887
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
Add options to JsonDecode and JsonEncode to wrap/unwrap json data Add options to JsonDecode and JsonEncode to wrap/unwrap json data Add options to JsonDecode and JsonEncode to wrap/unwrap json data Add options to JsonDecode and JsonEncode to wrap/unwrap json data Add options to JsonDecode and JsonEncode to wrap/unwrap json data
|
I like this idea, its a common JSON API patternt to have the top level object nested, and you have to create lots of extra model classes to handle this. E.g. some api gives {user: {name: fred, id: 1}} - at the moment to use the serializer with this I have to create a class that I dont really need: class UserResponse {
function setUser(User $u) {...}
}With this it can be avoided and become |
…n_decoder # Conflicts: # src/Symfony/Component/Serializer/Encoder/JsonDecode.php # src/Symfony/Component/Serializer/Encoder/JsonEncode.php
|
Wild thoughts: do we need this as |
|
What's the status of this PR? |
…n_decoder # Conflicts: # src/Symfony/Component/Serializer/Encoder/JsonDecode.php # src/Symfony/Component/Serializer/Encoder/JsonEncode.php # src/Symfony/Component/Serializer/Tests/Encoder/JsonDecodeTest.php # src/Symfony/Component/Serializer/Tests/Encoder/JsonEncodeTest.php
|
This PR should be rebased as it contains a merge commit that will forbid it to be merged? |
|
closing in favor of #30894 |
fabpot
added a commit
that referenced
this pull request
Apr 12, 2020
This PR was merged into the 5.1-dev branch. Discussion ---------- [Serializer] UnwrappingDenormalizer | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a UnwrappingDenormalizer, registered with very high priority. Unwrapping the data if UNWRAP_PATH is provided. Very often some APIs give nested responses in which we need only the child object. With UnwrappingDenormalizer we can get the needed object without creating unnecessary Model class that we don't really need. Regarding to #28887 and #30894 Usage: `$serialiser->deserialize('{"baz": {"foo": "bar", "inner": {"title": "value", "numbers": [5,3]}}}', Object::class, ['UnwrappingDenormalizer::UNWRAP_PATH' => '[baz][inner]'])` Commits ------- 00d103d UnwrappingDenormalizer
symfony-splitter
pushed a commit
to symfony/serializer
that referenced
this pull request
Apr 12, 2020
This PR was merged into the 5.1-dev branch. Discussion ---------- [Serializer] UnwrappingDenormalizer | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a UnwrappingDenormalizer, registered with very high priority. Unwrapping the data if UNWRAP_PATH is provided. Very often some APIs give nested responses in which we need only the child object. With UnwrappingDenormalizer we can get the needed object without creating unnecessary Model class that we don't really need. Regarding to symfony/symfony#28887 and symfony/symfony#30894 Usage: `$serialiser->deserialize('{"baz": {"foo": "bar", "inner": {"title": "value", "numbers": [5,3]}}}', Object::class, ['UnwrappingDenormalizer::UNWRAP_PATH' => '[baz][inner]'])` Commits ------- 00d103d5f7 UnwrappingDenormalizer
symfony-splitter
pushed a commit
to symfony/framework-bundle
that referenced
this pull request
Apr 12, 2020
This PR was merged into the 5.1-dev branch. Discussion ---------- [Serializer] UnwrappingDenormalizer | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a UnwrappingDenormalizer, registered with very high priority. Unwrapping the data if UNWRAP_PATH is provided. Very often some APIs give nested responses in which we need only the child object. With UnwrappingDenormalizer we can get the needed object without creating unnecessary Model class that we don't really need. Regarding to symfony/symfony#28887 and symfony/symfony#30894 Usage: `$serialiser->deserialize('{"baz": {"foo": "bar", "inner": {"title": "value", "numbers": [5,3]}}}', Object::class, ['UnwrappingDenormalizer::UNWRAP_PATH' => '[baz][inner]'])` Commits ------- 00d103d5f7 UnwrappingDenormalizer
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.
Add options to JsonDecode and JsonEncode to wrap/unwrap json data
Add options to JsonDecode and JsonEncode to wrap/unwrap json data.
So you can use:
$serialiser->deserialize("{object: {value: 1, other: 2}}", Object::class, ['json_root_key' => 'object'])