BrightNucleus\Config\AbstractConfig

Complexity

Total Complexity

19

Size/Duplication

Total Lines	225
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

96.49%

Importance

Changes	14
Bugs	1	Features	5

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	getAll()	0	4	1
A	getKeys()	0	4	1
A	getKeyArguments()	0	16	4
A	parseKeysString()	0	9	1
	isValid()	0	1	?
A	getKey()	0	13	2
A	getSubConfig()	0	9	1
A	validateKeys()	0	17	2
A	reduceToSubKey()	0	4	1
A	hasKey()	0	19	4

<?php
/**
 * Abstract Config Object
 *
 * @package   BrightNucleus\Config
 * @author    Alain Schlesser <alain.schlesser@gmail.com>
 * @license   GPL-2.0+
 * @link      http://www.brightnucleus.com/
 * @copyright 2016 Alain Schlesser, Bright Nucleus
 */

namespace BrightNucleus\Config;

use ArrayObject;
use Assert;
use BrightNucleus\Exception\BadMethodCallException;
use BrightNucleus\Exception\OutOfRangeException;
use Exception;

/**
 * Config loader used to load config PHP files as objects.
 *
 * @since      0.1.0
 *
 * @package    BrightNucleus\Config
 * @author     Alain Schlesser <alain.schlesser@gmail.com>
 */
abstract class AbstractConfig extends ArrayObject implements ConfigInterface
{

    /**
     * Array of strings that are used as delimiters to parse configuration keys.
     *
     * @since 0.1.6
     *
     * @var array
     */
    protected $delimiter = ['\\', '/', '.'];

    /**
     * Instantiate the AbstractConfig object.
     *
     * @since 0.1.0
     * @since 0.1.6 Accepts a delimiter to parse configuration keys.
     *
     * @param array                $config    Array with settings.
     * @param string[]|string|null $delimiter A string or array of strings that are used as delimiters to parse
     *                                        configuration keys. Defaults to "\", "/" & ".".
     */
    public function __construct(array $config, $delimiter = null)
    {
        // Make sure the config entries can be accessed as properties.
        parent::__construct($config, ArrayObject::ARRAY_AS_PROPS);

        if (null !== $delimiter) {
            $this->delimiter = (array)$delimiter;
        }
    }

    /**
     * Get the value of a specific key.
     *
     * To get a value several levels deep, add the keys for each level as a comma-separated list.
     *
     * @since 0.1.0
     * @since 0.1.4 Accepts list of keys.
     *
     * @param string $_ List of keys.
     * @return mixed
     * @throws BadMethodCallException If no argument was provided.
     * @throws OutOfRangeException If an unknown key is requested.
     */
    public function getKey($_)

Avoid variables with short names like $_. Configured minimum length is 3.

    {
        $keys = $this->validateKeys(func_get_args());

        $keys  = array_reverse($keys);
        $array = $this->getArrayCopy();
        while (count($keys) > 0) {
            $key   = array_pop($keys);
            $array = $array[$key];
        }

        return $array;
    }

    /**
     * Check whether the Config has a specific key.
     *
     * To check a value several levels deep, add the keys for each level as a comma-separated list.
     *
     * @since 0.1.0
     * @since 0.1.4 Accepts list of keys.
     *
     * @param string $_ List of keys.
     * @return bool
     */
    public function hasKey($_)

Avoid variables with short names like $_. Configured minimum length is 3.

    {
        try {
            $keys = array_reverse($this->getKeyArguments(func_get_args()));

            $array = $this->getArrayCopy();
            while (count($keys) > 0) {
                $key = array_pop($keys);
                if (! array_key_exists($key, $array)) {
                    return false;
                }
                $array = $array[$key];
            }
        } catch (Exception $exception) {
            return false;
        }

        return true;
    }

    /**
     * Get a (multi-dimensional) array of all the configuration settings.
     *
     * @since 0.1.4
     *
     * @return array
     */
    public function getAll()
    {
        return $this->getArrayCopy();
    }

    /**
     * Get the an array with all the keys
     *
     * @since 0.1.0
     * @return array

Consider making the return type a bit more specific; maybe use array<integer|string>.

     */
    public function getKeys()
    {
        return array_keys((array)$this);
    }

    /**
     * Get a new config at a specific sub-level.
     *
     * @since 0.1.13
     *
     * @param string $_ List of keys.
     * @return ConfigInterface

Consider making the return type a bit more specific; maybe use AbstractConfig.

     * @throws BadMethodCallException If no argument was provided.
     * @throws OutOfRangeException If an unknown key is requested.
     */
    public function getSubConfig($_)

Avoid variables with short names like $_. Configured minimum length is 3.

    {
        $keys = $this->validateKeys(func_get_args());

        $subConfig = clone $this;
        $subConfig->reduceToSubKey($keys);

        return $subConfig;
    }

    /**
     * Validate a set of keys to make sure they exist.
     *
     * @since 0.1.13
     *
     * @param string $_ List of keys.
     * @return array List of keys.
     * @throws BadMethodCallException If no argument was provided.
     * @throws OutOfRangeException If an unknown key is requested.
     */
    public function validateKeys($_)

The parameter $_ is not used and could be removed.

Avoid variables with short names like $_. Configured minimum length is 3.

    {
        $keys = $this->getKeyArguments(func_get_args());

        Assert\that($keys)->all()->string()->notEmpty();

        if (! $this->hasKey($keys)) {
            throw new OutOfRangeException(
                sprintf(
                    _('The configuration key %1$s does not exist.'),
                    implode('->', $keys)
                )
            );
        }

        return $keys;
    }

    /**
     * Reduce the currently stored config array to a subarray at a specific level.
     *
     * @since 0.1.13
     *
     * @param array $keys Array of keys that point to a key down in the hierarchy.
     */
    protected function reduceToSubKey(array $keys)
    {
        $this->exchangeArray($this->getKey($keys));
    }

    /**
     * Recursively extract the configuration key arguments from an arbitrary array.
     *
     * @since 0.1.6
     *
     * @param array $arguments Array as fetched through get_func_args().
     * @return array Array of strings.
     * @throws BadMethodCallException If no argument was provided.
     */
    protected function getKeyArguments($arguments)
    {
        Assert\that($arguments)->isArray()->notEmpty();

        $keys = [];
        foreach ($arguments as $argument) {
            if (is_array($argument)) {
                $keys = array_merge($keys, $this->getKeyArguments($argument));
            }
            if (is_string($argument)) {
                $keys = array_merge($keys, $this->parseKeysString($argument));
            }
        }

        return $keys;
    }

    /**
     * Extract individual keys from a delimited string.
     *
     * @since 0.1.6
     *
     * @param string $keyString Delimited string of keys.
     * @return array Array of key strings.
     */
    protected function parseKeysString($keyString)
    {
        Assert\that($keyString)->string()->notEmpty();

        // Replace all of the configured delimiters by the first one, so that we can then use explode().
        $normalizedString = str_replace($this->delimiter, $this->delimiter[0], $keyString);

        return (array)explode($this->delimiter[0], $normalizedString);
    }

    /**
     * Validate the Config file.
     *
     * @since  0.1.0
     * @return boolean
     */
    abstract public function isValid();
}