[Serializer] Add CDATA_WRAPPING_NAME_PATTERN support to XmlEncoder #60355
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
ad5bdb6 to
7477348
Compare
Spomky
reviewed
Jun 10, 2025
| ]]; | ||
|
|
||
| $this->assertEquals($expected, $this->encoder->encode($source, 'xml',[ | ||
| XmlEncoder::CDATA_WRAPPING_NAME_PATTERN => '(firstname|lastname|)' |
There was a problem hiding this comment.
With the test, I did not expected to see <other><![CDATA[data]]></other> but <other>data</other>.
It looks like it is due to the last | in '(firstname|lastname|)' right?
There was a problem hiding this comment.
Yes thats right. I will fix it
stof
reviewed
Jul 7, 2025
| ]]; | ||
|
|
||
| $this->assertEquals($expected, $this->encoder->encode($source, 'xml',[ | ||
| XmlEncoder::CDATA_WRAPPING_NAME_PATTERN => '(firstname|lastname|)' |
There was a problem hiding this comment.
using parenthesis as regex delimiter is quite uncommon. People reading the tests could think that we expect a partial pattern where we add the delimiter ourselves. I suggest changing the delimiters being used (and I also suggest using an anchored regex in that test)
| @@ -440,10 +442,15 @@ private function appendNode(\DOMNode $parentNode, mixed $data, string $format, a | |||
|
|
|||
| /** | |||
| * Checks if a value contains any characters which would require CDATA wrapping. | |||
| * | |||
| * @param array<mixed, mixed> $context | |||
There was a problem hiding this comment.
Suggested change
| * @param array<mixed, mixed> $context | |
| * @param array<string, mixed> $context |
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
CDATA_WRAPPING_NAME_PATTERNsupport to XmlEncoderThis PR introduces a new option for the Symfony Serializer component's
XmlEncoder:CDATA_WRAPPING_NAME_PATTERN.While Symfony already provides
CDATA_WRAPPING_PATTERNto wrap field content in CDATA based on a regex match, this new feature enables CDATA wrapping based on the field name—regardless of the field's content.Example use case:
This ensures that fields named
firstnameorlastnameare always wrapped in CDATA tags, even if their content doesn't match the typical pattern used byCDATA_WRAPPING_PATTERN.Motivation:
Consistent Output: In many integration scenarios (e.g., with legacy systems, XML consumers, or strict XSD schemas), consumers expect certain fields to always use CDATA sections—even when their content doesn't require escaping. This option allows for deterministic XML output by name.
Better Control: It separates concerns: one can now configure CDATA-wrapping for content-based needs and field-based policies independently.
Backward Compatible: The feature is fully optional and does not interfere with existing behavior unless the option is explicitly set.