Seboettg\Forest\GeneralTree

Complexity

Total Complexity

12

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Test Coverage

Coverage

91.18%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	getRoot()	0	3	1
A	child()	0	5	1
A	root()	0	6	1
A	count()	0	3	1
A	subTree()	0	6	1
A	endSubTree()	0	4	1
A	getNode()	0	3	1
A	nodeFactory()	0	8	3

<?php
declare(strict_types=1);
/*
 * Copyright (C) 2019 Sebastian Böttger <seboettg@gmail.com>
 * You may use, distribute and modify this code under the
 * terms of the MIT license.
 *
 * You should have received a copy of the MIT license with
 * this file. If not, please visit: https://opensource.org/licenses/mit-license.php
 */

namespace Seboettg\Forest;

use Countable;
use ErrorException;
use Seboettg\Collection\Stack;
use Seboettg\Forest\General\TreeNode;
use Seboettg\Forest\General\TreeNodeInterface;
use Seboettg\Forest\General\TreeTraversalInterface;
use Seboettg\Forest\General\TreeTraversalTrait;

/**
 * Class Builder
 * @package Seboettg\Forest
 */
class GeneralTree implements Countable, TreeTraversalInterface
{
    use TreeTraversalTrait;

    /**
     * @var Stack
     */
    private $treeNodeStack;

    /**
     * @var string
     */
    private $itemType;

    /**
     * @var int
     */
    private $elementCount = 0;

    /**
     * @var TreeNodeInterface
     */
    private $root;

    /**
     * GeneralTree constructor.
     * @param string $itemType
     * @throws ErrorException
     */
    public function __construct(string $itemType)
    {
        if (!class_exists($itemType)) {
            throw new ErrorException("Could not find class $itemType");
        }
        $this->itemType = $itemType;
    }

    /**
     * @param mixed $value
     * @return GeneralTree
     */
    public function root($value)
    {
        $this->treeNodeStack = new Stack();
        $this->root = $this->nodeFactory($value);
        $this->treeNodeStack->push($this->root);
        return $this;
    }

    /**
     * Add a child to the node enter in its scope
     *
     * @param mixed $value
     * @return GeneralTree
     */
    public function subTree($value)
    {
        $node = $this->nodeFactory($value);
        $this->treeNodeStack->peek()->addChild($node);
        $this->treeNodeStack->push($node);
        return $this;
    }

    /**
     * @param mixed $value
     * @return GeneralTree
     */
    public function child($value)
    {
        $node = $this->nodeFactory($value);
        $this->treeNodeStack->peek()->addChild($node);
        return $this;
    }

    /**
     * @return GeneralTree
     */
    public function endSubTree()
    {
        $this->treeNodeStack->pop();
        return $this;
    }

    /**
     * @param mixed $value
     * @return TreeNodeInterface
     */
    protected function nodeFactory($value): TreeNodeInterface
    {
        ++$this->elementCount;
        if (is_object($value) && get_class($value) === $this->itemType) {
            return new TreeNode($value);
        }
        $item = new $this->itemType($value);
        return new TreeNode($item);
    }

    /**
     * @return TreeNodeInterface
     */
    public function getNode(): ?TreeNodeInterface
    {
        return $this->treeNodeStack->peek();
    }

    /**
     * @return TreeNodeInterface
     */
    final public function getRoot(): ?TreeNodeInterface
    {
        return $this->root;
    }

    /**
     * @inheritDoc
     */
    final public function count(): int
    {
        return $this->elementCount;
    }
}