[Serializer] Add documentation about a new XmlEncoder CDATA wrapping opt-out context option #18155
Conversation
This file contains 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
2 tasks
nicolas-grekas
added a commit
to symfony/symfony
that referenced
this pull request
Oct 11, 2023
…option (AndoniLarz) This PR was merged into the 6.4 branch. Discussion ---------- [Serializer] Add `XmlEncoder::CDATA_WRAPPING` context option | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #26168 | License | MIT | Doc PR | symfony/symfony-docs#18155 Usage example : ```php $data = [ 'Hello' => 'Paul & Martha <or Me>', ]; return new Response( $this->serializer->serialize( $data, XmlEncoder::FORMAT, [ XmlEncoder::CDATA_WRAPPING => false ] ), headers: [ 'Content-Type' => 'application/xml' ] ); ``` will output ```xml <?xml version="1.0"?> <response><Hello>Paul & Martha <or Me></Hello></response> ``` instead of ```xml <?xml version="1.0"?> <response><Hello><![CDATA[Paul & Martha <or Me>]]></Hello></response> ``` --- As stated in [the following comment from PHP.net](https://www.php.net/manual/fr/domdocument.createtextnode.php#116351) : PHP automatically handles the escape when calling `DOMDocument::createTextNode` which is done in [::appendText](https://github.com/symfony/symfony/blob/6.3/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php#L193). `::appendText` is always called if `XmlEncoder::CDATA_WRAPPING => false`. --- Questions: * Should we allow for custom XPath to be wrapped in CDATA while others are simply escaped ? * Should we allow for a callback function to be used in place of a boolean (`callable(string $val): bool`) * [W3Schools#Entity References](https://www.w3schools.com/xml/xml_syntax.asp#:~:text=/note%3E-,Entity%20References,-Some%20characters%20have) states that `'` and `"` might also be escaped. Based on this should we instead provide a list of characters to escape/wrap ? (currently it would be set to `['<', '>', '&']`) --- - [X] Create the documentation PR - [X] Check Fabbot feedback to make sure code is well written Commits ------- 049982d [Serializer] Add `XmlEncoder::CDATA_WRAPPING` context option
AndoniLarz
force-pushed
the
feature/add-documentation-for-xml-encoder-cdata-wrapping-opt-out
branch
from
9437594
to
f0a98ad
Compare
|
Hi @xabbuh @OskarStark , I fixed the conflicts and updated the context option name following the code that has been merged. |
OskarStark
reviewed
Apr 29, 2024
OskarStark
reviewed
Apr 29, 2024
| ``cdata_wrapping`` If set to false, will not wrap any value ``true`` | ||
| containing one of the following characters ( | ||
| ``<``, ``>``, ``&``) in `a CDATA section`_ like | ||
| following : ``<![CDATA[...]]>`` | ||
| ============================== ================================================= ========================== | ||
|
|
There was a problem hiding this comment.
Please add a versionadded directive, you can find some as example in other files
|
Please target 7.1 branch for now, thanks |
Even though the feature has been added in 6.4 ? |
Ah sorry this is about another option. Sorry I mixed things up. No in this car 6.4 is fine, but a versionadded would be helpful at all: |
Alright no problem. I'll make the changes soon |
|
Open for finishing this PR by handling my comments? |
It should be good now 😄 |
…opt-out context option
OskarStark
force-pushed
the
feature/add-documentation-for-xml-encoder-cdata-wrapping-opt-out
branch
from
77e3a00
to
705d5d2
Compare
|
Thank you Andoni and congratulations on your first contribution to the Symfony documentation 🎉 |
AndoniLarz
deleted the
feature/add-documentation-for-xml-encoder-cdata-wrapping-opt-out
branch
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 of symfony/symfony#49893 which has been merged in 6.4.
TODO :
enable_cdata_wrapping=>cdata_wrapping)