WsdlToPhp / DomHandler

src/AbstractDomDocumentHandler.php

<?php

namespace WsdlToPhp\DomHandler;

use DOMElement;

abstract class AbstractDomDocumentHandler
{
    protected \DOMDocument $domDocument;

    protected ?ElementHandler $rootElement;

    public function __construct(\DOMDocument $domDocument)
    {
        $this->domDocument = $domDocument;
        $this->initRootElement();
    }

    /**
     * @param \DOMAttr|\DOMElement|\DOMNameSpaceNode|\DOMNode $node
     */
    public function getHandler($node, int $index = -1): AbstractNodeHandler
    {
        if ($node instanceof \DOMElement) {
            return $this->getElementHandler($node, $this, $index);
        }
        if ($node instanceof \DOMAttr) {
            return $this->getAttributeHandler($node, $this, $index);
        }
        if ($node instanceof \DOMNameSpaceNode) {
            return new NameSpaceHandler($node, $this, $index);
        }

        return $this->getNodeHandler($node, $this, $index);
    }

    public function getNodeByName(string $name): ?NodeHandler
    {
        return $this->domDocument->getElementsByTagName($name)->length > 0 ? $this->getNodeHandler($this->domDocument->getElementsByTagName($name)->item(0), $this) : null;
    }

    public function getElementByName(string $name): ?ElementHandler
    {
        $node = $this->getNodeByName($name);
        if ($node instanceof AbstractNodeHandler && $node->getNode() instanceof \DOMElement) {
            return $this->getElementHandler($node->getNode(), $this);
        }

        return null;
    }

    /**
     * @return AbstractAttributeHandler[]|AbstractElementHandler[]|AbstractNodeHandler[]
     */
    public function getNodesByName(string $name, ?string $checkInstance = null): array
    {
        $nodes = [];
        if ($this->domDocument->getElementsByTagName($name)->length > 0) {
            foreach ($this->domDocument->getElementsByTagName($name) as $node) {
                if (is_null($checkInstance) || $node instanceof $checkInstance) {
                    $nodes[] = $this->getHandler($node, count($nodes));
                }
            }
        }

        return $nodes;
    }

    /**
     * @return AbstractAttributeHandler[]|AbstractElementHandler[]|AbstractNodeHandler[]
     */
    public function getElementsByName(string $name): array
    {
        return $this->getNodesByName($name, \DOMElement::class);
    }

    /**
     * @param string[] $attributes
     *
     * @return AbstractAttributeHandler[]|AbstractElementHandler[]|AbstractNodeHandler[]
     */
    public function getElementsByNameAndAttributes(string $name, array $attributes, ?\DOMNode $node = null): array
    {
        $matchingElements = $this->getElementsByName($name);
        if ((!empty($attributes) || $node instanceof \DOMNode) && !empty($matchingElements)) {
            $nodes = $this->searchTagsByXpath($name, $attributes, $node);

            if (false !== $nodes) {
                $matchingElements = $this->getElementsHandlers($nodes);
            }
        }

        return $matchingElements;
    }

    /**
     * @param \DOMNodeList<\DOMAttr|\DOMElement|\DOMNode> $nodeList
     *
     * @return AbstractElementHandler[]
     */
    public function getElementsHandlers(\DOMNodeList $nodeList): array
    {
        $nodes = [];
        if (0 === $nodeList->count()) {
            return $nodes;
        }

        $index = 0;
        foreach ($nodeList as $node) {
            if (!$node instanceof \DOMElement) {
                continue;
            }

            $nodes[] = $this->getElementHandler($node, $this, $index);
            ++$index;
        }

        return $nodes;
    }

    /**
     * @param string[] $attributes
     *
     * @return \DOMNodeList<\DOMAttr|\DOMElement|\DOMNode>|false
     */
    public function searchTagsByXpath(string $name, array $attributes, ?\DOMNode $node = null)
    {
        $xpath = new \DOMXPath($node ? $node->ownerDocument : $this->domDocument);

It seems like $node ? $node->ownerDocument : $this->domDocument can also be of type null; however, parameter $document of DOMXPath::__construct() does only seem to accept DOMDocument, maybe add an additional type check?

        $xQuery = sprintf("%s//*[local-name()='%s']", $node instanceof \DOMNode ? '.' : '', $name);
        foreach ($attributes as $attributeName => $attributeValue) {
            if (false !== strpos($attributeValue, '*')) {
                $xQuery .= sprintf("[contains(@%s, '%s')]", $attributeName, str_replace('*', '', $attributeValue));
            } else {
                $xQuery .= sprintf("[@%s='%s']", $attributeName, $attributeValue);
            }
        }

        return $xpath->query($xQuery, $node);
    }

    /**
     * @param string[] $attributes
     */
    public function getElementByNameAndAttributes(string $name, array $attributes): ?ElementHandler
    {
        $elements = $this->getElementsByNameAndAttributes($name, $attributes);

        $element = array_shift($elements);

        return $element instanceof ElementHandler ? $element : null;
    }

    /**
     * Find valid root node (not a comment, at least a DOMElement node).
     *
     * @throws \InvalidArgumentException
     */
    protected function initRootElement(): void
    {
        if ($this->domDocument->hasChildNodes()) {
            foreach ($this->domDocument->childNodes as $node) {
                if ($node instanceof \DOMElement) {
                    $this->rootElement = $this->getElementHandler($node, $this);

                    break;
                }
            }
        } else {
            throw new \InvalidArgumentException('Document seems to be invalid', __LINE__);
        }
    }

    abstract protected function getNodeHandler(\DOMNode $node, AbstractDomDocumentHandler $domDocument, int $index = -1): NodeHandler;

    abstract protected function getElementHandler(\DOMElement $element, AbstractDomDocumentHandler $domDocument, int $index = -1): ElementHandler;

    abstract protected function getAttributeHandler(\DOMAttr $attribute, AbstractDomDocumentHandler $domDocument, int $index = -1): AttributeHandler;
}