brightnucleus / config

src/ConfigTrait.php

Indentation +99 added lines, -99 removed lines

@@ -1,13 +1,13 @@ 
 <?php
 /**
- * Config Trait
- *
- * @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
- */
+	 * Config Trait
+	 *
+	 * @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;
 
@@ -18,102 +18,102 @@ 
 trait ConfigTrait
 {
 
-    /**
-     * Reference to the Config object.
-     *
-     * @since 0.1.2
-     *
-     * @var ConfigInterface
-     */
-    protected $config;
+	/**
+	 * Reference to the Config object.
+	 *
+	 * @since 0.1.2
+	 *
+	 * @var ConfigInterface
+	 */
+	protected $config;
 
-    /**
-     * Process the passed-in configuration file.
-     *
-     * @since 0.1.2
-     *
-     * @param ConfigInterface $config The Config to process.
-     * @param                 string  ... List of keys.
-     * @throws RuntimeException If the arguments could not be parsed into a Config.
-     */
-    protected function processConfig(ConfigInterface $config)
-    {
-        if (func_num_args() > 1) {
-            try {
-                $keys = func_get_args();
-                array_shift($keys);
-                $config = $config->getSubConfig($keys);
-            } catch (Exception $exception) {
-                throw new RuntimeException(
-                    sprintf(
-                        _('Could not process the config with the arguments "%1$s".'),
-                        print_r(func_get_args(), true)
-                    )
-                );
-            }
-        }
-        $this->config = $config;
-    }
+	/**
+	 * Process the passed-in configuration file.
+	 *
+	 * @since 0.1.2
+	 *
+	 * @param ConfigInterface $config The Config to process.
+	 * @param                 string  ... List of keys.
+	 * @throws RuntimeException If the arguments could not be parsed into a Config.
+	 */
+	protected function processConfig(ConfigInterface $config)
+	{
+		if (func_num_args() > 1) {
+			try {
+				$keys = func_get_args();
+				array_shift($keys);
+				$config = $config->getSubConfig($keys);
+			} catch (Exception $exception) {
+				throw new RuntimeException(
+					sprintf(
+						_('Could not process the config with the arguments "%1$s".'),
+						print_r(func_get_args(), true)
+					)
+				);
+			}
+		}
+		$this->config = $config;
+	}
 
-    /**
-     * Check whether the Config has a specific key.
-     *
-     * To get a value several levels deep, add the keys for each level as a comma-separated list.
-     *
-     * @since 0.1.2
-     * @since 0.1.5 Accepts list of keys.
-     *
-     * @param string|array $_ List of keys.
-     * @return bool Whether the key is known.
-     */
-    protected function hasConfigKey($_)
-    {
-        $keys = func_get_args();
-        Assert\that($keys)->all()->string()->notEmpty();
+	/**
+	 * Check whether the Config has a specific key.
+	 *
+	 * To get a value several levels deep, add the keys for each level as a comma-separated list.
+	 *
+	 * @since 0.1.2
+	 * @since 0.1.5 Accepts list of keys.
+	 *
+	 * @param string|array $_ List of keys.
+	 * @return bool Whether the key is known.
+	 */
+	protected function hasConfigKey($_)
+	{
+		$keys = func_get_args();
+		Assert\that($keys)->all()->string()->notEmpty();
 
-        return $this->config->hasKey($keys);
-    }
+		return $this->config->hasKey($keys);
+	}
 
-    /**
-     * Get the Config value for a specific key.
-     *
-     * To get a value several levels deep, add the keys for each level as a comma-separated list.
-     *
-     * @since 0.1.2
-     * @since 0.1.5 Accepts list of keys.
-     *
-     * @param string|array $_ List of keys.
-     * @return mixed Value of the key.
-     */
-    protected function getConfigKey($_)
-    {
-        $keys = func_get_args();
-        Assert\that($keys)->all()->string()->notEmpty();
+	/**
+	 * Get the Config value for a specific key.
+	 *
+	 * To get a value several levels deep, add the keys for each level as a comma-separated list.
+	 *
+	 * @since 0.1.2
+	 * @since 0.1.5 Accepts list of keys.
+	 *
+	 * @param string|array $_ List of keys.
+	 * @return mixed Value of the key.
+	 */
+	protected function getConfigKey($_)
+	{
+		$keys = func_get_args();
+		Assert\that($keys)->all()->string()->notEmpty();
 
-        return $this->config->getKey($keys);
-    }
+		return $this->config->getKey($keys);
+	}
 
-    /**
-     * Get a (multi-dimensional) array of all the configuration settings.
-     *
-     * @since 0.1.4
-     *
-     * @return array All the configuration settings.
-     */
-    protected function getConfigArray()
-    {
-        return $this->config->getAll();
-    }
+	/**
+	 * Get a (multi-dimensional) array of all the configuration settings.
+	 *
+	 * @since 0.1.4
+	 *
+	 * @return array All the configuration settings.
+	 */
+	protected function getConfigArray()
+	{
+		return $this->config->getAll();
+	}
 
-    /**
-     * Get an array of all the keys that are known by the Config.
-     *
-     * @since 0.1.2
-     *
-     * @return array Array of strings containing all the keys.
-     */
-    protected function getConfigKeys()
-    {
-        return $this->config->getKeys();
-    }
+	/**
+	 * Get an array of all the keys that are known by the Config.
+	 *
+	 * @since 0.1.2
+	 *
+	 * @return array Array of strings containing all the keys.
+	 */
+	protected function getConfigKeys()
+	{
+		return $this->config->getKeys();
+	}
 }

src/AbstractConfig.php

Indentation +229 added lines, -229 removed lines

@@ -1,13 +1,13 @@ 
 <?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
- */
+	 * 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;
 
@@ -28,225 +28,225 @@ 
 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|array $_ List of keys.
-     * @return mixed
-     * @throws BadMethodCallException If no argument was provided.
-     * @throws OutOfRangeException If an unknown key is requested.
-     */
-    public function getKey($_)
-    {
-        $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|array $_ List of keys.
-     * @return bool
-     */
-    public function hasKey($_)
-    {
-        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
-     */
-    public function getKeys()
-    {
-        return array_keys((array)$this);
-    }
-
-    /**
-     * Get a new config at a specific sub-level.
-     *
-     * @since 0.1.13
-     *
-     * @param string|array $_ List of keys.
-     * @return ConfigInterface
-     * @throws BadMethodCallException If no argument was provided.
-     * @throws OutOfRangeException If an unknown key is requested.
-     */
-    public function getSubConfig($_)
-    {
-        $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|array $_ 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($_)
-    {
-        $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();
+	/**
+	 * 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|array $_ List of keys.
+	 * @return mixed
+	 * @throws BadMethodCallException If no argument was provided.
+	 * @throws OutOfRangeException If an unknown key is requested.
+	 */
+	public function getKey($_)
+	{
+		$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|array $_ List of keys.
+	 * @return bool
+	 */
+	public function hasKey($_)
+	{
+		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
+	 */
+	public function getKeys()
+	{
+		return array_keys((array)$this);
+	}
+
+	/**
+	 * Get a new config at a specific sub-level.
+	 *
+	 * @since 0.1.13
+	 *
+	 * @param string|array $_ List of keys.
+	 * @return ConfigInterface
+	 * @throws BadMethodCallException If no argument was provided.
+	 * @throws OutOfRangeException If an unknown key is requested.
+	 */
+	public function getSubConfig($_)
+	{
+		$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|array $_ 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($_)
+	{
+		$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();
 }