feature #18155 [Serializer] Add documentation about a new XmlEncoder CDATA wrapping opt-out context option (AndoniLarz)

OskarStark · OskarStark · commit cb08b4616c7c · 2024-05-16T07:14:17.000+02:00
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [Serializer] Add documentation about a new XmlEncoder CDATA wrapping opt-out context option Add documentation of symfony/symfony#49893 which has been merged in 6.4. TODO : - [x] Fix conflicts (by rebasing) - [x] Edit the context option name (`enable_cdata_wrapping` => `cdata_wrapping`) - [x] Wait for the reviews Commits ------- 705d5d2 [Serializer] Add documentation about a new XmlEncoder CDATA wrapping opt-out context option
diff --git a/components/serializer.rst b/components/serializer.rst
@@ -1206,8 +1206,16 @@ Option                          Description
 ``save_options``                XML saving `options with libxml`_                  ``0``
 ``remove_empty_tags``           If set to true, removes all empty tags in the      ``false``
                                 generated XML
+``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[...]]>``
 ==============================  =================================================  ==========================
 
+.. versionadded:: 6.4
+
+    The `cdata_wrapping` option was introduced in Symfony 6.4.
+
 Example with custom ``context``::
 
     use Symfony\Component\Serializer\Encoder\XmlEncoder;
@@ -1936,3 +1944,4 @@ Learn more
 .. _`data URI`: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
 .. _seld/jsonlint: https://github.com/Seldaek/jsonlint
 .. _$flags: https://www.php.net/manual/en/json.constants.php
+.. _`a CDATA section`: https://en.wikipedia.org/wiki/CDATA
