bingo-soft / xml

src/Impl/Instance/DomElementImpl.php

<?php

namespace Xml\Impl\Instance;

use Xml\Impl\ModelInstanceImpl;
use Xml\Instance\{
    DomDocumentInterface,
    DomElementInterface,
    ModelElementInstanceInterface
};
use Xml\Impl\Util\XmlQName;
use Xml\Impl\Util\DomUtil;

class DomElementImpl implements DomElementInterface
{
    private const MODEL_ELEMENT_KEY = "example.modelElementRef";
    private const XMLNS_ATTRIBUTE_NS_URI = "http://www.w3.org/2000/xmlns/";
    private const XMLNS_ATTRIBUTE = "xmlns";

    private $element;

    private $document;

    private $modelElementInstance;

The private property $modelElementInstance is not used, and could be removed.

    public function __construct(DomElementExt $element)
    {
        $this->element = $element;
        $this->document = $element->ownerDocument;
    }

    public function getElement(): ?DomElementExt
    {
        return $this->element;
    }

    public function getNamespaceURI(): string
    {
        return $this->element->namespaceURI;

The expression return $this->element->namespaceURI could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    public function getLocalName(): string
    {
        return $this->element->localName;
    }

    public function getPrefix(): string
    {
        return $this->element->prefix;

The expression return $this->element->prefix could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    public function getDocument(): ?DomDocumentInterface
    {
        $ownerDocument = $this->element->ownerDocument;
        if ($ownerDocument !== null) {
            return new DomDocumentImpl($ownerDocument);
        } else {
            return null;
        }
    }

    public function getRootElement(): ?DomElementInterface
    {
        $document = $this->getDocument();
        if ($document !== null) {
            return $document->getRootElement();
        } else {
            return null;
        }
    }

    public function getParentElement(): ?DomElementInterface
    {
        $parentNode = $this->element->parentNode;
        if ($parentNode !== null && $parentNode instanceof DomElementExt) {
            return new DomElementImpl($parentNode);
        } else {
            return null;
        }
    }

    public function getChildElements(): array
    {
        $childNodes = $this->element->childNodes;
        return DomUtil::filterNodeListForElements($childNodes);
    }

    /**
     * @param mixed $uris
     * @param string $elementName
     */
    public function getChildElementsByNameNs($uris, string $elementName): array
    {
        $childNodes = $this->element->childNodes;
        $result = [];
        if (is_string($uris)) {
            $result = DomUtil::filterNodeListByName($childNodes, $uris, $elementName);
        } elseif (is_array($uris)) {
            foreach ($uris as $uri) {
                $result = array_merge($result, DomUtil::filterNodeListByName($childNodes, $uri, $elementName));
            }
        }
        return $result;
    }


    public function getChildElementsByType(
        ModelInstanceImpl $modelInstance,
        string $elementType
    ): array {
        $childNodes = $this->element->childNodes;
        return DomUtil::filterNodeListByType($childNodes, $modelInstance, $elementType);
    }

    public function replaceChild(
        DomElementInterface $newChildDomElement,
        DomElementInterface $existingChildDomElement
    ): void {
        $newElement = $newChildDomElement->getElement();
        $existingElement = $existingChildDomElement->getElement();
        if ($this->element->replaceChild($newElement, $existingElement) === false) {

It seems like $existingElement can also be of type null; however, parameter $child of DOMNode::replaceChild() does only seem to accept DOMNode, maybe add an additional type check?

It seems like $newElement can also be of type null; however, parameter $node of DOMNode::replaceChild() does only seem to accept DOMNode, maybe add an additional type check?

            throw new \DOMException("Unable to replace child element with new element");
        }
    }

    public function removeChild(DomElementInterface $childDomElement): bool
    {
        $childElement = $childDomElement->getElement();
        try {
            $this->element->removeChild($childElement);

It seems like $childElement can also be of type null; however, parameter $child of DOMNode::removeChild() does only seem to accept DOMNode, maybe add an additional type check?

            return true;
        } catch (\Exception $e) {
            return false;
        }
    }

    public function appendChild(DomElementInterface $childDomElement): void
    {
        $childElement = $childDomElement->getElement();
        $this->element->appendChild($childElement);

It seems like $childElement can also be of type null; however, parameter $node of DOMNode::appendChild() does only seem to accept DOMNode, maybe add an additional type check?

    }

    public function insertChildElementAfter(
        DomElementInterface $elementToInsert,
        ?DomElementInterface $insertAfter
    ): void {
        $newElement = $elementToInsert->getElement();
        if ($insertAfter === null) {
            $insertBeforeNode = $this->element->firstChild;
        } else {
            $insertBeforeNode = $insertAfter->getElement()->nextSibling;
        }

        if ($insertBeforeNode !== null) {
            $this->element->insertBefore($newElement, $insertBeforeNode);

It seems like $newElement can also be of type null; however, parameter $node of DOMNode::insertBefore() does only seem to accept DOMNode, maybe add an additional type check?

        } else {
            $this->element->appendChild($newElement);

It seems like $newElement can also be of type null; however, parameter $node of DOMNode::appendChild() does only seem to accept DOMNode, maybe add an additional type check?

        }
    }

    public function hasAttribute(?string $namespaceUri, string $localName): bool
    {
        if ($namespaceUri === null) {
            return $this->element->hasAttribute($localName);
        } else {
            return $this->element->hasAttributeNS($namespaceUri, $localName);
        }
    }

    public function getAttribute(?string $namespaceUri, string $localName): ?string
    {
        $xmlQName = new XmlQName($this->getDocument(), $this, $namespaceUri, $localName);
        if ($xmlQName->hasLocalNamespace()) {
            $value = $this->element->getAttribute($xmlQName->getLocalName());
        } else {
            $value = $this->element->getAttributeNS($xmlQName->getNamespaceUri(), $xmlQName->getLocalName());
        }

        if (empty($value)) {
            return null;
        } else {
            return $value;
        }
    }

    public function setAttribute(?string $namespaceUri, string $localName, string $value, ?bool $isIdAttribute = false): void
    {
        $isIdAttribute = $isIdAttribute ?? false;
        $xmlQName = new XmlQName($this->getDocument(), $this, $namespaceUri, $localName);
        if ($xmlQName->hasLocalNamespace()) {
            $this->element->setAttribute($xmlQName->getLocalName(), $value);
            if ($isIdAttribute && !$this->element->getAttributeNode($localName)->isId()) {
                $this->element->setIdAttribute($xmlQName->getLocalName(), true);
            }
        } else {
            //PHP does not create prefix automatically, like Java
            $prefixedName = $xmlQName->getPrefixedName();
            if (strpos($prefixedName, ":") === false) {
                $prefix = $this->getDocument()->getUnusedGenericNsPrefix();
                $prefixedName = $prefix . ":" . $localName;
            }
            $this->element->setAttributeNS($xmlQName->getNamespaceUri(), $prefixedName, $value);
            if ($isIdAttribute && !$this->element->getAttributeNodeNS($xmlQName->getNamespaceUri(), $localName)->isId()) {
                $this->element->setIdAttributeNS($xmlQName->getNamespaceUri(), $xmlQName->getLocalName(), true);
            }
        }
    }

    public function setIdAttribute(?string $namespaceUri, string $localName, string $value): void
    {
        $namespaceUri = $namespaceUri ?? $this->getNamespaceURI();
        $this->setAttribute($namespaceUri, $localName, $value, true);
    }

    public function removeAttribute(?string $namespaceUri, string $localName): void
    {
        $namespaceUri = $namespaceUri ?? $this->getNamespaceURI();
        $xmlQName = new XmlQName($this->getDocument(), $this, $namespaceUri, $localName);
        if ($xmlQName->hasLocalNamespace()) {
            $this->element->removeAttribute($xmlQName->getLocalName());
        } else {
            $this->element->removeAttributeNS($xmlQName->getNamespaceUri(), $xmlQName->getLocalName());
        }
    }

    public function getTextContent(): string
    {
        return $this->element->textContent;
    }

    public function setTextContent(string $textContent): void
    {
        $this->element->nodeValue = $textContent;
    }

    public function addCDataSection(string $data): void
    {
        $document = $this->getDocument();
        $cdataSection = $document->createCDATASection($data);

The method createCDATASection() does not exist on Xml\Impl\Instance\DomDocumentImpl.

        $this->element->appendChild($cdataSection);
    }

    public function getModelElementInstance(): ?ModelElementInstanceInterface
    {
        //return $this->modelElementInstance;
        return $this->element->getUserData(self::MODEL_ELEMENT_KEY);
    }

    public function setModelElementInstance(ModelElementInstanceInterface $modelElementInstance): void
    {
        //$this->modelElementInstance = $modelElementInstance;
        $this->element->setUserData(self::MODEL_ELEMENT_KEY, $modelElementInstance, null);
    }

    /**
     * @return mixed
     */
    public function registerNamespace(?string $prefix, string $namespaceUri)
    {
        if ($prefix !== null) {
            $this->element->setAttributeNS(
                self::XMLNS_ATTRIBUTE_NS_URI,
                self::XMLNS_ATTRIBUTE . ":" . $prefix,
                $namespaceUri
            );
        } else {
            $lookupPrefix = $this->lookupPrefix($namespaceUri);
            if ($lookupPrefix === null) {
                if (array_key_exists($namespaceUri, XmlQName::KNOWN_PREFIXES)) {
                    $prefix = XmlQName::KNOWN_PREFIXES[$namespaceUri];
                }
                if (
                    $prefix !== null &&
                    $this->getRootElement() !== null &&
                    $this->getRootElement()->element->hasAttributeNS(self::XMLNS_ATTRIBUTE_NS_URI, $prefix)
                ) {
                    $prefix = null;
                }
                if ($prefix === null) {
                    $prefix = $this->getDocument()->getUnusedGenericNsPrefix();
                }
                $this->registerNamespace($prefix, $namespaceUri);
                return $prefix;
            } else {
                return $lookupPrefix;
            }
        }
    }

    public function lookupPrefix(string $namespaceUri): ?string
    {
        return $this->element->lookupPrefix($namespaceUri);
    }

    public function equals(?DomElementInterface $obj): bool
    {
        if ($obj === null) {
            return false;
        }

        return $this->element->isSameNode($obj->getElement());

It seems like $obj->getElement() can also be of type null; however, parameter $otherNode of DOMNode::isSameNode() does only seem to accept DOMNode, maybe add an additional type check?

    }
}