Borobudur\Config\Definition\Builder\ArrayDefinition

Complexity

Total Complexity

13

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	6
Bugs	4	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setBuilder()	0	4	1
A	append()	0	14	2
A	children()	0	4	1
A	prototype()	0	4	1
A	getNodeBuilder()	0	8	2
A	createNode()	0	15	2
A	instantiateArrayNode()	0	11	2
A	instantiatePrototypeArrayNode()	0	13	2

<?php
/*
 * This file is part of the Borobudur-Config package.
 *
 * (c) Hexacodelabs <http://hexacodelabs.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Borobudur\Config\Definition\Builder;

use Borobudur\Config\Definition\ArrayNode;
use Borobudur\Config\Definition\NodeInterface;
use Borobudur\Config\Definition\PrototypeArrayNode;
use Borobudur\Config\Exception\InvalidArgumentException;

/**
 * @author      Iqbal Maulana <iq.bluejack@gmail.com>
 * @created     8/10/15
 */
class ArrayDefinition extends AbstractDefinition implements NodeDefinitionContainerInterface
{
    /**
     * @var NodeDefinitionInterface[]
     */
    protected $children = array();

    /**
     * @var NodeDefinitionInterface
     */
    protected $prototype;

    /**
     * @var array
     */
    protected $nullEquivalent = array();

    /**
     * @var NodeDefinitionBuilder|null
     */
    protected $nodeBuilder;

    /**
     * {@inheritdoc}
     */
    public function setBuilder(NodeDefinitionBuilder $builder)
    {
        $this->nodeBuilder = $builder;
    }

    /**
     * {@inheritdoc}
     */
    public function append(NodeDefinitionInterface $node)
    {
        if (isset($this->children[$node->getName()])) {
            throw new InvalidArgumentException(sprintf(
                'Config named "%s" in "%s" already defined.',
                $node->getName(),
                $this->getName()
            ));
        }

        $this->children[$node->getName()] = $node->setParent($this);

        return $this;
    }

    /**
     * Chain children to builder.
     *
     * @return NodeDefinitionBuilder
     */
    public function children()
    {
        return $this->getNodeBuilder();
    }

    /**
     * Set array as prototype (numeric array) with definition type of children.
     *
     * @param string $type
     *
     * @return NodeDefinitionInterface
     */
    public function prototype($type)
    {
        return $this->prototype = $this->getNodeBuilder()->node(null, $type)->setParent($this);
    }

    /**
     * Get node definition builder.
     *
     * @return NodeDefinitionBuilder
     */
    protected function getNodeBuilder()
    {
        if (null === $this->nodeBuilder) {
            $this->nodeBuilder = new NodeDefinitionBuilder();
        }

        return $this->nodeBuilder->setParent($this);
    }

    /**
     * Create and configure node by definition.
     *
     * @return NodeInterface
     */
    protected function createNode()
    {
        $this->assertParentNode();

        if (null === $this->prototype) {
            $node = $this->instantiateArrayNode();
        } else {
            $node = $this->instantiatePrototypeArrayNode();
        }

        $node->setRequired($this->required);
        $node->setAllowOverwrite($this->allowOverwrite);

        return $node;
    }

    /**
     * Create array node.
     *
     * @return ArrayNode
     */
    private function instantiateArrayNode()
    {
        $node = new ArrayNode($this->name, $this->parent);

It seems like $this->parent can also be of type object<Borobudur\Config\Definition\Builder\DefinitionInterface> or object<Borobudur\Config\Definition\Builder\NodeDefinitionInterface>; however, Borobudur\Config\Definition\AbstractNode::__construct() does only seem to accept null|object<Borobudur\Config\Definition\NodeInterface>, maybe add an additional type check?

        foreach ($this->children as $child) {
            $child->setParent($node);
            $node->append($child->getNode());
        }

        return $node;
    }

    /**
     * Create prototype array node.
     *
     * @return PrototypeArrayNode
     */
    private function instantiatePrototypeArrayNode()
    {
        $node = new PrototypeArrayNode($this->name, $this->parent);

It seems like $this->parent can also be of type object<Borobudur\Config\Definition\Builder\DefinitionInterface> or object<Borobudur\Config\Definition\Builder\NodeDefinitionInterface>; however, Borobudur\Config\Definition\AbstractNode::__construct() does only seem to accept null|object<Borobudur\Config\Definition\NodeInterface>, maybe add an additional type check?

        if ($this->defaultValueSet) {
            $node->setDefaultValue($this->defaultValue);
        }

        $this->prototype->setParent($node);
        $node->setPrototype($this->prototype->getNode());

$this->prototype->getNode() of type object<Borobudur\Config\Definition\NodeInterface> is not a sub-type of object<Borobudur\Config\Definition\PrototypeNodeInterface>. It seems like you assume a child interface of the interface Borobudur\Config\Definition\NodeInterface to be always present.

        return $node;
    }
}