Add documentation for XmlEncoder context param #7231
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
javiereguiluz
approved these changes
Dec 8, 2016
stof
reviewed
Dec 8, 2016
components/serializer.rst
Outdated
| The array keys beginning with ``@`` are considered XML attributes:: | ||
|
|
||
| $encoder = new XmlEncoder(); | ||
| $encoder->encode(array('foo' => array('@bar' => 'value'))); |
There was a problem hiding this comment.
the XmlEncoder class won't be called directly. It will be called when using $serializer->serialize($data, 'xml', $context)
stof
reviewed
Dec 8, 2016
components/serializer.rst
Outdated
| ``xml_root_node_name`` | ||
| Change the root node name (default: ``response``). | ||
|
|
||
| ``remove_empty_tags`` |
There was a problem hiding this comment.
Context options related to the XML encoder should not be documented in the main chapter of the serializer doc IMO (but this should be decided by the doc team).
And if we document them (which is a good idea), context options supported by encoders for other formats should be documented too.
|
Hi @xabbuh ! If you can take care of them when merging that would be great, I'm not really fluent in english :/ Thanks |
Thanks! |
javiereguiluz
added a commit
that referenced
this pull request
Jan 5, 2018
… javiereguiluz) This PR was submitted for the master branch but it was merged into the 3.3 branch instead (closes #7231). Discussion ---------- Add documentation for XmlEncoder context param Add documentation for XmlEncoder context param Related to : symfony/symfony#20524 This fixes #7227 Commits ------- 5e23045 Minor tweaks adbc7b2 Minor rewords 2dc6ed3 Minor syntax issue 6050370 Minor syntax issues and some rewordings 2f3cf02 Correcting my bad english with a bilingual friend 60c7657 Add XmlEncoder documentation with $context available options 04af434 erratum c83e59d Add XmlEncoder documentation with $context available options
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 documentation for XmlEncoder context param
Related to : symfony/symfony#20524
This fixes #7227