JMS\Serializer\Type\Compiler\Llk\TreeNode

Complexity

Total Complexity

24

Size/Duplication

Total Lines	281
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	appendChild()	0	5	1
A	setId()	0	6	1
A	__destruct()	0	5	1
A	getChildren()	0	3	1
A	setValue()	0	6	1
A	childExists()	0	3	1
A	setChildren()	0	6	1
A	getValue()	0	3	1
A	getChildrenNumber()	0	3	1
A	getValueToken()	0	3	1
A	getData()	0	3	1
A	getParent()	0	3	1
A	setParent()	0	6	1
A	accept()	0	6	1
A	prependChild()	0	5	1
A	getChild()	0	5	2
A	isToken()	0	3	1
A	getValueValue()	0	3	1
A	__construct()	0	19	3
A	getOffset()	0	3	1
A	getId()	0	3	1

<?php

declare(strict_types=1);

/**
 * Hoa
 *
 *
 *
 *
 * BSD 3-Clause License
 *
 * Copyright © 2007-2017, Hoa community. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

namespace JMS\Serializer\Type\Compiler\Llk;

use Hoa\Visitor;
use Hoa\Visitor\Visit;

/**
 * Class \JMS\Serializer\Type\Compiler\Llk\TreeNode.
 *
 * Provide a generic node for the AST produced by LL(k) parser.
 */
final class TreeNode implements Visitor\Element
{
    /**
     * ID (should be something like #ruleName or token).
     *
     * @var string
     */
    protected $_id       = '';

    /**
     * Value of the node (non-null for token nodes).
     *
     * @var array|null
     */
    protected $_value    = null;

    /**
     * Children.
     *
     * @var array
     */
    protected $_children = [];

    /**
     * Parent.
     *
     * @var \JMS\Serializer\Type\Compiler\Llk\TreeNode|null
     */
    protected $_parent = null;

    /**
     * Attached data.
     *
     * @var array
     */
    protected $_data     = [];



    /**
     * @param   string                      $id       ID.
     * @param   array                       $value    Value.
     * @param   array                       $children Children.
     * @param   \JMS\Serializer\Type\Compiler\Llk\TreeNode  $parent   Parent.
     */
    public function __construct(
        string $id,
        ?array $value = null,
        array $children = [],
        ?self $parent = null
    ) {
        $this->setId($id);

        if (!empty($value)) {
            $this->setValue($value);
        }

        $this->setChildren($children);

        if (null !== $parent) {
            $this->setParent($parent);
        }

        return;
    }

    /**
     * Set ID.
     *
     * @param   string  $id ID.
     */
    public function setId(string $id): string
    {
        $old       = $this->_id;
        $this->_id = $id;

        return $old;
    }

    /**
     * Get ID.
     */
    public function getId(): string
    {
        return $this->_id;
    }

    /**
     * Set value.
     *
     * @param   array  $value Value (token & value).
     *
     * @return  array|null
     */
    public function setValue(array $value): ?array
    {
        $old          = $this->_value;
        $this->_value = $value;

        return $old;
    }

    /**
     * Get value.
     *
     * @return  array|null
     */
    public function getValue(): ?array
    {
        return $this->_value;
    }

    /**
     * Get value token.
     */
    public function getValueToken(): string
    {
        return $this->_value['token'] ?? null;

The expression return $this->_value['token'] ?? null could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get value value.
     */
    public function getValueValue(): string
    {
        return $this->_value['value'] ?? null;

The expression return $this->_value['value'] ?? null could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get token offset.
     */
    public function getOffset(): int
    {
        return $this->_value['offset'] ?? 0;
    }

    /**
     * Check if the node represents a token or not.
     */
    public function isToken(): bool
    {
        return !empty($this->_value);
    }

    /**
     * Prepend a child.
     *
     * @param   \JMS\Serializer\Type\Compiler\Llk\TreeNode  $child Child.
     */
    public function prependChild(self $child): \JMS\Serializer\Type\Compiler\Llk\TreeNode
    {
        array_unshift($this->_children, $child);

        return $this;
    }

    /**
     * Append a child.
     *
     * @param   \JMS\Serializer\Type\Compiler\Llk\TreeNode  $child Child.
     */
    public function appendChild(self $child): \JMS\Serializer\Type\Compiler\Llk\TreeNode
    {
        $this->_children[] = $child;

        return $this;
    }

    /**
     * Set children.
     *
     * @param   array  $children Children.
     *
     * @return  array
     */
    public function setChildren(array $children): array
    {
        $old             = $this->_children;
        $this->_children = $children;

        return $old;
    }

    /**
     * Get child.
     *
     * @param   int  $i Index.
     */
    public function getChild(int $i): \JMS\Serializer\Type\Compiler\Llk\TreeNode
    {
        return true === $this->childExists($i)

The expression return true === $this->childExists($i) ? $this->_children[$i] : null could return the type null which is incompatible with the type-hinted return JMS\Serializer\Type\Compiler\Llk\TreeNode. Consider adding an additional type-check to rule them out.

                ? $this->_children[$i]
                : null;
    }

    /**
     * Get children.
     *
     * @return  array
     */
    public function getChildren(): array
    {
        return $this->_children;
    }

    /**
     * Get number of children.
     */
    public function getChildrenNumber(): int
    {
        return count($this->_children);
    }

    /**
     * Check if a child exists.
     *
     * @param   int  $i Index.
     */
    public function childExists(int $i): bool
    {
        return array_key_exists($i, $this->_children);
    }

    /**
     * Set parent.
     *
     * @param   \JMS\Serializer\Type\Compiler\Llk\TreeNode  $parent Parent.
     */
    public function setParent(self $parent): ?\JMS\Serializer\Type\Compiler\Llk\TreeNode
    {
        $old           = $this->_parent;
        $this->_parent = $parent;

        return $old;
    }

    /**
     * Get parent.
     */
    public function getParent(): ?\JMS\Serializer\Type\Compiler\Llk\TreeNode
    {
        return $this->_parent;
    }

    /**
     * Get data.
     *
     * @return  array
     */
    public function &getData(): array
    {
        return $this->_data;
    }

    /**
     * Accept a visitor.
     *
     * @param   Visit  $visitor Visitor.
     * @param   mixed               &$handle Handle (reference).
     * @param   mixed               $eldnah  Handle (no reference).
     *
     * @return  mixed
     */
    public function accept(
        Visitor\Visit $visitor,
        &$handle = null,
        $eldnah = null
    ) {
        return $visitor->visit($this, $handle, $eldnah);
    }

    /**
     * Remove circular reference to the parent (help the garbage collector).
     *
     * @return  void
     */
    public function __destruct()
    {
        unset($this->_parent);

        return;
    }
}