DocumentToLookupArrayReader.php

<?php
declare(strict_types=1);

namespace Soap\Encoding\Xml\Reader;

use Dom\Attr;
use Dom\Node;
use Soap\Encoding\Xml\Node\Element;
use Soap\Encoding\Xml\Node\ElementList;
use VeeWee\Xml\Xmlns\Xmlns;
use function VeeWee\Xml\Dom\Predicate\is_element;

/**
 * @psalm-type LookupArrayValue = string|Element|ElementList
 * @psalm-type LookupArray = array<string, LookupArrayValue>
 */
final class DocumentToLookupArrayReader
{
    /**
     * @return LookupArray
     */
    public function __invoke(Element $xml): array
    {
        $root = $xml->element();
        /** @var LookupArray $nodes */
        $nodes = [];

        // Read all child elements.
        // The key is the name of the elements
        // The value is the raw XML for those element(s)
        /** @var iterable<Node> $children */
        $children = $root->childNodes;
        foreach ($children as $element) {
            if (!is_element($element)) {
                continue;
            }

            $key = $element->localName;
            $previousValue = $nodes[$key] ?? null;
            $currentElement = Element::fromDOMElement($element);

            // Incrementally build up lists.
            /** @var LookupArrayValue $value */
            $value = match(true) {
                $previousValue instanceof ElementList => $previousValue->append($currentElement),
                $previousValue instanceof Element => new ElementList($previousValue, $currentElement),
                default => $currentElement

            };
            $nodes[$key] = $value;
        }

        // It might be possible that the child is a regular textNode.
        // In that case, we use '_' as the key and the value of the textNode as value.
        if (!$nodes && $root->getAttributeNS(Xmlns::xsi()->value(), 'nil') !== 'true') {
            $nodes['_'] = $root->textContent ?? '';
        }

        // All attributes also need to be added as key => value pairs.
        /** @var \iterable<Attr> $attributes */
        $attributes = $root->attributes;
        foreach ($attributes as $attribute) {
            $key = $attribute->localName;
            $nodes[$key] = $attribute->value;
        }

        return $nodes;
    }
}