[WIP] Reorganize the Serializer documentation #6428
Closed
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
| As a final result, the deserializer uses the ``first_name`` attribute as if | ||
| it were ``firstName`` and uses the ``getFirstName`` and ``setFirstName`` methods. | ||
|
|
||
| Using Callbacks to Serialize Properties with Object Instances |
There was a problem hiding this comment.
this should be moved to other chapters rather than removed
There was a problem hiding this comment.
Yes, I plan to move it to the normalizer doc ;-)
GuilhemN
force-pushed
the
SERIALIZER
branch
2 times, most recently
from
da8a235 to
2d4ff3b
Compare
|
I wrote the doc about encoders. |
This was referenced Jun 26, 2016
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 aim of this PR is to split the Serializer component documentation into smaller articles: the encoders and the normalizers will have their own dedicated section.
The encoders documentation won't be necessary for everyone but it is always good to understand how they work. For example, I don't think that a lot of people knows that the
XmlEncoderconsiders keys beginning with@as attributes.The
JsonEncoderisn't really complex but it may be useful to know that it is based on the built in methodsjson_encodeandjson_decode.The documentation about normalizers is much more needed as they are a great feature not much documented for now. The
ObjectNormalizer(or theGetSetMethodNormalizerfor the 2.3 branch) is enough in most of the cases but sometimes people want something even more powerful and could use custom normalizers if they knew more about them.So please tell me if you like this reorganization and if you see anything to change before I start writing the sections about normalizers and encoders :-)