Inspirum\XML\Services\XMLReader

Complexity

Total Complexity

43

Size/Duplication

Total Lines	330
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	__destruct()	0	4	1
A	open()	0	16	2
A	iterateNode()	0	16	4
A	nextNode()	0	10	2
A	moveToNode()	0	10	4
A	moveToNextNode()	0	16	4
B	readNode()	0	40	10
A	read()	0	6	1
A	getNodeName()	0	4	1
A	getNodeType()	0	4	1
A	getNodeValue()	0	4	1
A	isNodeElementType()	0	4	1
A	isNodeEmptyElementType()	0	4	1
A	isNodeElementEndType()	0	4	1
A	isNodeTextType()	0	4	2
A	isNodeType()	0	4	1
A	getNodeAttributes()	0	13	3
A	withErrorHandler()	0	14	2

<?php

namespace Inspirum\XML\Services;

use Exception;
use XMLReader as BaseXMLReader;

class XMLReader
{
    /**
     * XML Reader
     *
     * @var \XMLReader
     */
    private $reader;

    /**
     * XML document
     *
     * @var \Inspirum\XML\Services\XML
     */
    private $xml;

    /**
     * XMLReader constructor
     *
     * @param string $filepath
     */
    public function __construct(string $filepath)
    {
        $this->reader = $this->open($filepath);
        $this->xml    = new XML();
    }

    /**
     * XMLReader destructor
     */
    public function __destruct()
    {
        $this->reader->close();
    }

    /**
     * Open file
     *
     * @param string $filepath
     *
     * @return \XMLReader
     *
     * @throws \Exception
     */
    private function open(string $filepath): BaseXMLReader
    {
        $xmlReader = new BaseXMLReader();

        $opened = $this->withErrorHandler(function () use ($xmlReader, $filepath) {
            return $xmlReader->open($filepath);
        });

        if ($opened == false) {
            // @codeCoverageIgnoreStart
            throw new Exception('\XMLReader::open() method failed');
            // @codeCoverageIgnoreEnd
        }

        return $xmlReader;
    }

    /**
     * Parse file and yield next node
     *
     * @param string $nodeName
     *
     * @return \Generator|\Inspirum\XML\Services\XMLNode[]
     */
    public function iterateNode(string $nodeName): iterable
    {
        $found = $this->moveToNode($nodeName);

        if ($found === false) {
            return yield from [];
        }

        do {
            $item = $this->readNode();

            if ($item !== null) {
                yield $item;
            }
        } while ($this->moveToNextNode($nodeName));
    }

    /**
     * Get next node
     *
     * @param string $nodeName
     *
     * @return \Inspirum\XML\Services\XMLNode|null
     */
    public function nextNode(string $nodeName): ?XMLNode
    {
        $found = $this->moveToNode($nodeName);

        if ($found === false) {
            return null;
        }

        return $this->readNode();
    }

    /**
     * Move to first element by tag name
     *
     * @param string $nodeName
     *
     * @return bool
     */
    private function moveToNode(string $nodeName): bool
    {
        while ($this->read()) {
            if ($this->isNodeElementType() && $this->getNodeName() === $nodeName) {
                return true;
            }
        }

        return false;
    }

    /**
     * Move to next sibling element by tag name
     *
     * @param string $nodeName
     *
     * @return bool
     */
    private function moveToNextNode(string $nodeName): bool
    {
        $localName = Formatter::getLocalName($nodeName);

        if ($localName === null) {
            return false;
        }

        while ($this->reader->next($localName)) {
            if ($this->getNodeName() === $nodeName) {
                return true;
            }
        }

        return false;
    }

    /**
     * Return associative array of element by name
     *
     * @return \Inspirum\XML\Services\XMLNode|null
     */
    private function readNode(): ?XMLNode
    {
        $nodeName   = $this->getNodeName();
        $attributes = $this->getNodeAttributes();

        if ($this->isNodeEmptyElementType()) {
            return $this->xml->createElement($nodeName, $attributes);
        }

        $node     = null;
        $text     = null;
        $elements = [];

        while ($this->read()) {
            if ($this->isNodeElementEndType() && $this->getNodeName() == $nodeName) {
                $node = $this->xml->createTextElement($nodeName, $text, $attributes);

                foreach ($elements as $element) {
                    $node->append($element);
                }

                break;
            } elseif ($this->isNodeTextType()) {
                $text = $this->getNodeValue();
            } elseif ($this->isNodeElementType()) {
                if ($this->isNodeEmptyElementType()) {
                    $elements[] = $this->xml->createElement($this->getNodeName());
                    continue;
                }

                $element = $this->readNode();

                if ($element instanceof XMLNode) {
                    $elements[] = $element;
                }
            }
        }

        return $node;
    }

    /**
     * Move to next node in document
     *
     * @return bool
     *
     * @throws \DOMException
     */
    private function read(): bool
    {
        return $this->withErrorHandler(function () {
            return $this->reader->read();
        });
    }

    /**
     * Get current node name
     *
     * @return string
     */
    private function getNodeName(): string
    {
        return $this->reader->name;
    }

    /**
     * Get current node type
     *
     * @return int
     */
    private function getNodeType(): int
    {
        return $this->reader->nodeType;
    }

    /**
     * Get current node value
     *
     * @return string
     */
    private function getNodeValue(): string
    {
        return $this->reader->value;
    }

    /**
     * If current node is element open tag
     *
     * @return bool
     */
    private function isNodeElementType(): bool
    {
        return $this->isNodeType(BaseXMLReader::ELEMENT);
    }

    /**
     * If current node is element open tag
     *
     * @return bool
     */
    private function isNodeEmptyElementType(): bool
    {
        return $this->reader->isEmptyElement;
    }

    /**
     * If current node is element close tag
     *
     * @return bool
     */
    private function isNodeElementEndType(): bool
    {
        return $this->isNodeType(BaseXMLReader::END_ELEMENT);
    }

    /**
     * If current node is text content
     *
     * @return bool
     */
    private function isNodeTextType(): bool
    {
        return $this->isNodeType(BaseXMLReader::TEXT) || $this->isNodeType(BaseXMLReader::CDATA);
    }

    /**
     * If current node is given node type
     *
     * @param int $type
     *
     * @return bool
     */
    private function isNodeType(int $type): bool
    {
        return $this->getNodeType() === $type;
    }

    /**
     * Get current node attributes
     *
     * @return array<string,string>
     */
    private function getNodeAttributes(): array
    {
        $attributes = [];

        if ($this->reader->hasAttributes) {
            while ($this->reader->moveToNextAttribute()) {
                $attributes[$this->getNodeName()] = $this->getNodeValue();
            }
            $this->reader->moveToElement();
        }

        return $attributes;
    }

    /**
     * Register custom error handler to throw Exception on warning message
     *
     * @param callable $callback
     *
     * @return mixed
     *
     * @throws \DOMException
     */
    protected function withErrorHandler(callable $callback)
    {
        set_error_handler(function (int $code, string $message) {
            if (strpos($message, 'XMLReader::') !== false) {
                throw new Exception($message, $code);
            }
        });

        $response = $callback();

        restore_error_handler();

        return $response;
    }
}