Skip to content

fix: escape XML special characters in addChild text content #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
guillaumedelre wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: escape XML special characters in addChild text content #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion source/FluidXml/FluidInsertionHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,9 +269,15 @@ protected function insertStringSimple($parent, $k, $v, $fn): array
// The user has passed an element name and an element value:
// [ 'element' => 'Element content' ]

$el = $this->createElement($k, $v);
$el = $this->createElement($k);
$el = $fn($parent, $el);

// createTextNode escapes XML special characters (&, <, >, etc.)
// DOMElement's constructor does not, so we avoid passing value there.
if ($v !== null && $v !== '') {
$el->appendChild($this->dom->createTextNode((string) $v));
}

return [ $el ];
}

Expand Down
26 changes: 26 additions & 0 deletions specs/FluidXml.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1181,6 +1181,32 @@ function addchild($parent, $i)
assert_equal_xml($xml, $expected);
});

it('should escape XML special characters in text content using the argument syntax', function () {
$xml = new FluidXml();
$xml->addChild('child1', 'a & b')
->addChild('parent', true)
->addChild('child2', 'a < b');

$expected = "<doc>\n"
. " <child1>a &amp; b</child1>\n"
. " <parent>\n"
. " <child2>a &lt; b</child2>\n"
. " </parent>\n"
. "</doc>";
assert_equal_xml($xml, $expected);
});

it('should escape XML special characters in text content using the array syntax', function () {
$xml = new FluidXml();
$xml->addChild(['child1' => 'Hello & World', 'child2' => 'Tom & Jerry']);

$expected = "<doc>\n"
. " <child1>Hello &amp; World</child1>\n"
. " <child2>Tom &amp; Jerry</child2>\n"
. "</doc>";
assert_equal_xml($xml, $expected);
});

it('should add many children with and without a value', function () {
$xml = new FluidXml();
$xml->addChild(['child1', 'child2', 'child3' => 'value3', 'child4' => 'value4'])
Expand Down