DaveRandom\Jom\Node

Complexity

Total Complexity

17

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Test Coverage

Coverage

58.54%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getFirstChild()	0	3	1
A	getKey()	0	3	1
A	getParent()	0	3	1
A	getLastChild()	0	3	1
A	__clone()	0	3	1
A	containsChild()	0	3	1
A	getPreviousSibling()	0	3	1
A	getOwnerDocument()	0	3	1
A	setReferences()	0	6	1
A	getNextSibling()	0	3	1
B	createFromValue()	0	30	5
A	hasChildren()	0	3	1
A	__construct()	0	3	1

<?php declare(strict_types=1);

namespace DaveRandom\Jom;

use DaveRandom\Jom\Exceptions\InvalidNodeValueException;

abstract class Node implements \JsonSerializable
{
    public const IGNORE_INVALID_VALUES = 0b01;
    public const PERMIT_INCORRECT_REFERENCE_TYPE = 0b10;

    protected $ownerDocument;

    /** @var string|int|null */
    protected $key;

    /** @var VectorNode|null */
    protected $parent;

    /** @var Node|null */
    protected $previousSibling;

    /** @var Node|null */
    protected $nextSibling;

    /**
     * @throws InvalidNodeValueException
     * @return static
     */
    public static function createFromValue($value, ?Document $ownerDocument = null, ?int $flags = 0): Node
    {
        static $nodeFactory;

        $flags = $flags ?? 0;

        try {
            $result = ($nodeFactory ?? $nodeFactory = new UnsafeNodeFactory)
                ->createNodeFromValue($value, $ownerDocument, $flags);
        } catch (InvalidNodeValueException $e) {
            throw $e;
        //@codeCoverageIgnoreStart
        } catch (\Exception $e) {
            /** @noinspection PhpInternalEntityUsedInspection */
            throw unexpected($e);
        }
        //@codeCoverageIgnoreEnd

        // Check that the created node matches the class used to call the method
        if (!($result instanceof static) && !($flags & self::PERMIT_INCORRECT_REFERENCE_TYPE)) {
            /** @noinspection PhpInternalEntityUsedInspection */
            throw new InvalidNodeValueException(\sprintf(
                "Value of type %s parsed as instance of %s, instance of %s expected",
                describe($value),
                \get_class($result),
                static::class
            ));
        }

        return $result;
    }

    protected function __construct(?Document $ownerDocument)
    {
        $this->ownerDocument = $ownerDocument;
    }

    public function __clone()
    {
        $this->setReferences(null, null, null, null);
    }

    final protected function setReferences(?VectorNode $parent, $key, ?Node $previousSibling, ?Node $nextSibling): void
    {
        $this->parent = $parent;
        $this->key = $key;
        $this->previousSibling = $previousSibling;
        $this->nextSibling = $nextSibling;
    }

    final public function getParent(): ?VectorNode
    {
        return $this->parent;
    }

    final public function getPreviousSibling(): ?Node
    {
        return $this->previousSibling;
    }

    final public function getNextSibling(): ?Node
    {
        return $this->nextSibling;
    }

    public function hasChildren(): bool
    {
        return false;
    }

    public function containsChild(/** @noinspection PhpUnusedParameterInspection */ Node $child): bool
    {
        return false;
    }

    public function getFirstChild(): ?Node
    {
        return null;
    }

    public function getLastChild(): ?Node
    {
        return null;
    }

    final public function getOwnerDocument(): ?Document
    {
        return $this->ownerDocument;
    }

    /**
     * @return string|int|null
     */
    final public function getKey()
    {
        return $this->key;
    }

    abstract public function getValue();
    abstract public function jsonSerialize();
}