Xml::arrayToXml fails on nested arrays

Open Beginner friendly
#7 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
php
Domain
testing-qa

Research direction

Start at the Xml::arrayToXml helper and reproduce the nested-array example from the issue. Inspect the recursive branch where the nested element is passed before it exists, then verify that the example produces the expected nested XML without PHP errors.

Written by the indexing model from the issue text.

Description

The helper function arrayToXml has code indended to handle nested arrays, but currently always throws PHP errors. This means nested arrays can't be used when testing soap functions with array data either.

Reproduce

Code:

$dom = new \DOMDocument();
$array = [
    'foo' => [
        'bar' => '1'
    ]
];
echo \Codeception\Util\Xml::arrayToXml($dom, $dom, $array)->saveXML();

Expected output:

<?xml version="1.0"?>
<foo><bar>1</bar></foo>

Result:

Undefined property: DOMDocument::$foo
Cause

When the function encounters an array, it calls itself to parse the array, with $domNode->$el as the new $domNode parameter. The problem is that that node ->$el will never exist, since that's the node this function was supposed to create in the first place.

Fix

Create a new element first, to pass to the recursive call, and then append that new node to the xml structure.

Current code:

            if (is_array($val)) {
                self::arrayToXml($xml, $domNode->$el, $val);
            } else {
                $domNode->appendChild($xml->createElement($el, $val));
            }

Fixed code:

            if (is_array($val)) {
                $elementNode = $xml->createElement($el);
                self::arrayToXml($xml, $elementNode, $val);
                $domNode->appendChild($elementNode);
            } else {
                $domNode->appendChild($xml->createElement($el, $val));
            }

Alternatively, we could make it a little more consistent by always creating and appending the element in the same way, and only set the value inside the if-condition. That code would look like this:

            $elementNode = $xml->createElement($el);
            if (is_array($val)) {
                self::arrayToXml($xml, $elementNode, $val);
            } else {
                $elementNode->nodeValue = $val;
            }
            $domNode->appendChild($elementNode);

Both solutions result in working code for nested arrays.

Dominant language
PHP
Stars
17
Forks
1
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Codeception/lib-xml

All issues in Codeception/lib-xml

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.