Borobudur\Config\Definition\AbstractNode

Complexity

Total Complexity

17

Size/Duplication

Total Lines	223
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes	2
Bugs	0	Features	1

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getName()	0	4	1
A	setPath()	0	4	1
A	getPath()	0	10	2
A	setParent()	0	6	1
A	getParent()	0	4	1
A	setAllowOverwrite()	0	4	1
A	setDefaultValue()	0	5	1
A	getDefaultValue()	0	4	1
A	setRequired()	0	4	1
A	isRequired()	0	4	1
A	hasDefaultValue()	0	4	1
A	normalize()	0	6	1
A	merge()	0	14	2
A	finalize()	0	6	1
	validateType()	0	1	?
	normalizeValue()	0	1	?
	mergeValues()	0	1	?
	finalizeValue()	0	1	?

<?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;

use Borobudur\Config\Exception\InvalidConfigurationException;
use Borobudur\Config\Exception\InvalidTypeException;

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

    /**
     * @var string
     */
    protected $path;

    /**
     * @var NodeInterface
     */
    protected $parent;

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

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

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

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

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

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

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

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

        if (null !== $this->parent) {
            $path = $this->parent->getPath().'.'.$path;
        }

        return $path;
    }

    /**
     * {@inheritdoc}
     */
    public function setParent(NodeInterface $parent)
    {
        $this->parent = $parent;

        return $this;
    }

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

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

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

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

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

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

    /**
     * {@inheritdoc}
     */
    public function hasDefaultValue()
    {
        return null !== $this->defaultValue;
    }

    /**
     * {@inheritdoc}
     */
    final public function normalize($value)
    {
        $this->validateType($value);

        return $this->normalizeValue($value);
    }

    /**
     * {@inheritdoc}
     */
    final public function merge($left, $right)
    {
        if (false === $this->allowOverwrite) {
            throw new InvalidConfigurationException(sprintf(
                'Configuration path "%s" cannot be overwritten.',
                $this->getPath()
            ));
        }

        $this->validateType($left);
        $this->validateType($right);

        return $this->mergeValues($left, $right);
    }

    /**
     * Finalize and validate type and value.
     *
     * @param mixed $value
     *
     * @return mixed
     */
    final public function finalize($value)
    {
        $this->validateType($value);

        return $this->finalizeValue($value);
    }

    /**
     * Validate type of a Node.
     *
     * @param mixed $value
     *
     * @throws InvalidTypeException
     */
    abstract protected function validateType($value);

    /**
     * Normalize value.
     *
     * @param mixed $value
     *
     * @return mixed
     */
    abstract protected function normalizeValue($value);

    /**
     * Merge between two elements.
     *
     * @param mixed $left
     * @param mixed $right
     *
     * @return mixed
     */
    abstract protected function mergeValues($left, $right);

    /**
     * Finalize and validate value.
     *
     * @param mixed $value
     */
    abstract protected function finalizeValue($value);
}