Borobudur\Config\Definition\Builder\AbstractDefinition

Complexity

Total Complexity

20

Size/Duplication

Total Lines	193
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	2

Importance

Changes	5
Bugs	2	Features	2

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setName()	0	4	1
A	getName()	0	4	1
A	setParent()	0	13	3
A	end()	0	4	1
A	cannotBeOverwritten()	0	6	1
A	defaultValue()	0	7	1
A	defaultNull()	0	6	1
A	defaultTrue()	0	4	1
A	defaultFalse()	0	4	1
A	isRequired()	0	6	1
A	getNode()	0	4	1
A	assertParentNode()	0	9	3
	createNode()	0	1	?
A	isValidParentInstance()	0	6	3

<?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\NodeInterface;
use Borobudur\Config\Definition\PrototypeNodeInterface;
use Borobudur\Config\Exception\InvalidArgumentException;
use Borobudur\Config\Exception\RuntimeException;

/**
 * @author      Iqbal Maulana <iq.bluejack@gmail.com>
 * @created     8/10/15
 */
abstract class AbstractDefinition implements NodeDefinitionInterface
{
    /**
     * @var string
     */
    protected $name;

    /**
     * @var mixed
     */
    protected $defaultValue;

    /**
     * @var bool
     */
    protected $defaultValueSet = false;

    /**
     * @var bool
     */
    protected $required = false;

    /**
     * @var mixed
     */
    protected $nullEquivalent;

    /**
     * @var DefinitionInterface|NodeDefinitionInterface|NodeInterface|null
     */
    protected $parent;

    /**
     * @var bool
     */
    protected $allowOverwrite = true;

    /**
     * Constructor.
     *
     * @param string $name
     * @param NodeDefinitionInterface|null $parent
     */
    public function __construct($name, NodeDefinitionInterface $parent = null)
    {
        $this->name = $name;
        $this->parent = $parent;
    }

    /**
     * {@inheritdoc}
     */
    public function setName($name)
    {
        $this->name = $name;
    }

    /**
     * Get node name.
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * {@inheritdoc}
     */
    public function setParent($parent = null)
    {
        if (null !== $parent && $this->isValidParentInstance($parent)) {
            throw new InvalidArgumentException(sprintf(
                'Parent "%s" should be instance of DefinitionInterface, NodeDefinitionInterface or NodeInterface.',
                get_class($parent)
            ));
        }

        $this->parent = $parent;

        return $this;
    }

    /**
     * {@inheritdoc}
     *
     * @return NodeInterface|NodeDefinitionBuilder|DefinitionInterface|NodeDefinitionContainerInterface|null
     */
    public function end()
    {
        return $this->parent;
    }

    /**
     * {@inheritdoc}
     */
    public function cannotBeOverwritten()
    {
        $this->allowOverwrite = false;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function defaultValue($value)
    {
        $this->defaultValueSet = true;
        $this->defaultValue = $value;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function defaultNull()
    {
        $this->defaultValue = $this->nullEquivalent;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function defaultTrue()
    {
        return $this->defaultValue(true);
    }

    /**
     * {@inheritdoc}
     */
    public function defaultFalse()
    {
        return $this->defaultValue(false);
    }

    /**
     * {@inheritdoc}
     */
    public function isRequired()
    {
        $this->required = true;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getNode()
    {
        return $this->createNode();
    }

    /**
     * Assert that correct node parent.
     */
    protected function assertParentNode()
    {
        if (null !== $this->parent && false === $this->parent instanceof NodeInterface) {
            throw new RuntimeException(sprintf(
                '"%s" should implement \Borobudur\Config\Definition\NodeInterface',
                get_class($this->parent)
            ));
        }
    }

    /**
     * Create and configure node by definition.
     *
     * @return NodeInterface|PrototypeNodeInterface
     */
    abstract protected function createNode();

    /**
     * Check if parent is valid instance.
     *
     * @param mixed $parent
     *
     * @return bool
     */
    private function isValidParentInstance($parent)
    {
        return false === $parent instanceof DefinitionInterface
            && false === $parent instanceof NodeDefinitionInterface
            && false === $parent instanceof NodeInterface;
    }
}