[Serializer] XmlEncoder doesn't ignore PI nodes while encoding #27926
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
|
We follow the robustness principle "Be conservative in what you send, be liberal in what you accept", so while it's ok to ignore I suggest to add a new constructor parameter: public function __construct(string $rootNodeName = 'response', int $loadOptions = null, array $decoderIgnoredNodeTypes = array(XML_PI_NODE, XML_COMMENT_NODE), array $encoderIgnoredNodeTypes = array()) |
d3d136d to
9c182a2
Compare
|
I followed your suggestion @dunglas, could you review ? |
|
Is the "BC break" label still valid? If not can you please update the PR description? Rebase needed btw. |
9c182a2 to
e289848
Compare
e289848 to
2223fcc
Compare
|
@nicolas-grekas Done :) |
nicolas-grekas
approved these changes
Aug 24, 2018
dunglas
approved these changes
Aug 25, 2018
|
Thank you @maidmaid. |
dunglas
added a commit
that referenced
this pull request
Aug 25, 2018
…encoding (maidmaid)
This PR was merged into the 4.2-dev branch.
Discussion
----------
[Serializer] XmlEncoder doesn't ignore PI nodes while encoding
| Q | A
| ------------- | ---
| Branch? | master
| Bug fix? | no
| New feature? | yes
| BC breaks? | no
| Deprecations? | no
| Tests pass? | no
| Fixed tickets | /
| License | MIT
| Doc PR | /
It's sometimes important to get only the XML body without the processing instructions (like the `<?xml version="1.0" ?>` on the top of your XML doc). At the moment, it's possible to ignore them while decoding, but not while encoding.
```php
$encoder = new XmlEncoder('response', null, $ignoredNodeTypes = [XML_PI_NODE]);
echo $encoder->encode([], 'xml');
```
```
Expected:
<response/>
Actual:
<?xml version="1.0"?>
<response/>
```
So, a new `$encoderIgnoredNodeTypes` arg is added to the constructor which will be:
```php
public function __construct(string $rootNodeName = 'response', int $loadOptions = null, array $decoderIgnoredNodeTypes = array(XML_PI_NODE, XML_COMMENT_NODE), array $encoderIgnoredNodeTypes = array())
```
Commits
-------
2223fcc Allow to ignore PI while encoding
fabpot
added a commit
that referenced
this pull request
Aug 27, 2018
…redNodeTypes arg in XmlEncoder contrustor (maidmaid) This PR was merged into the 4.2-dev branch. Discussion ---------- [Serializer] Update changelog about the new $encoderIgnoredNodeTypes arg in XmlEncoder contrustor | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #27926 | License | MIT | Doc PR | / Commits ------- 49f3bfc Update changelog
fabpot
added a commit
that referenced
this pull request
Aug 30, 2018
…ML encoding (maidmaid) This PR was merged into the 4.2-dev branch. Discussion ---------- [Serializer] Add support for ignoring comments while XML encoding | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | / | License | MIT | Doc PR | / In addition to #27926 which allowed to ignore XML processing instructions, this PR allows to ignore the XML comments while encoding. Commits ------- 8f8230a Add support for ignoring comments while XML encoding
|
I've created symfony/symfony-docs#10286 to document this new feature. Please, don't forget to create a doc issue for every new feature. |
This was referenced Nov 3, 2018
Closed
Merged
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.
It's sometimes important to get only the XML body without the processing instructions (like the
<?xml version="1.0" ?>on the top of your XML doc). At the moment, it's possible to ignore them while decoding, but not while encoding.So, a new
$encoderIgnoredNodeTypesarg is added to the constructor which will be: