[Serializer] documentation for allow_extra_attributes #6975
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
f4400f3 to
e6818fc
Compare
xabbuh
reviewed
Sep 22, 2016
components/serializer.rst
Outdated
| has a fourth parameter, the context. If you want to throw an exception if an attribute is outside | ||
| the object scope, use ``allow_extra_attributes`` as ``false``. | ||
|
|
||
| This will throws a :class:`Symfony\\Component\\Serializer\\Exception\\ExtraAttributesException` exception, |
xabbuh
reviewed
Sep 22, 2016
components/serializer.rst
Outdated
| the object scope, use ``allow_extra_attributes`` as ``false``. | ||
|
|
||
| This will throws a :class:`Symfony\\Component\\Serializer\\Exception\\ExtraAttributesException` exception, | ||
| because city is not an attribute of ``Acme\Person``:: |
There was a problem hiding this comment.
[...] because city is not an attribute of the Person class
xabbuh
reviewed
Sep 22, 2016
components/serializer.rst
Outdated
| by the serializer. | ||
| :method:`Symfony\\Component\\Serializer\\Serializer::deserialize` | ||
| has a fourth parameter, the context. If you want to throw an exception if an attribute is outside | ||
| the object scope, use ``allow_extra_attributes`` as ``false``. |
There was a problem hiding this comment.
I would reword this a bit:
By default, additional attributes that are not mapped to the denormalized object will be ignored by the Serializer component. Set the
allow_extra_attributeskey of the deserialization context tofalseto let the serializer throw an exception when additional attributes are passed.
e6818fc to
8318e14
Compare
8318e14 to
28dcc94
Compare
|
@xabbuh thanks for your review |
dunglas
approved these changes
Oct 6, 2016
symfony-splitter
pushed a commit
to symfony/serializer
that referenced
this pull request
Dec 5, 2016
… used during an object denor… (juliendidier) This PR was merged into the 3.3-dev branch. Discussion ---------- [Serializer] Throw exception when extra attributes are used during an object denor… | Q | A | | --- | --- | | Branch? | "master" | | Bug fix? | no | | New feature? | yes | | BC breaks? | no | | Deprecations? | no | | Tests pass? | yes | | Fixed tickets | #19948 | | License | MIT | | Doc PR | [#6975](symfony/symfony-docs#6975) | I will update the doc if you're ok with this PR. Commits ------- 565a984 throw exception when extra attributes are used during an object denormalization
dunglas
added a commit
to symfony/symfony
that referenced
this pull request
Dec 5, 2016
… used during an object denor… (juliendidier) This PR was merged into the 3.3-dev branch. Discussion ---------- [Serializer] Throw exception when extra attributes are used during an object denor… | Q | A | | --- | --- | | Branch? | "master" | | Bug fix? | no | | New feature? | yes | | BC breaks? | no | | Deprecations? | no | | Tests pass? | yes | | Fixed tickets | #19948 | | License | MIT | | Doc PR | [#6975](symfony/symfony-docs#6975) | I will update the doc if you're ok with this PR. Commits ------- 565a984 throw exception when extra attributes are used during an object denormalization
|
The code PR has been merged. |
|
👍 (there is a minor issue with the line length and the second paragraph can maybe replaced by a code comment in de code itself, but those things can be fixed during the merge) |
|
Thank you @juliendidier. |
xabbuh
added a commit
that referenced
this pull request
Mar 3, 2017
…juliendidier) This PR was merged into the master branch. Discussion ---------- [Serializer] documentation for allow_extra_attributes Doc PR for [symfony/symfony#19958](symfony/symfony#19958) Commits ------- 28dcc94 [Serializer] documentation for allow_extra_attributes
xabbuh
added a commit
that referenced
this pull request
Mar 3, 2017
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.
Doc PR for symfony/symfony#19958