brightnucleus / config

src/AbstractConfig.php

Indentation +163 added lines, -163 removed lines

@@ -27,167 +27,167 @@
 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;
-        }
-    }
-
-    /**
-     * 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
-     * @throws BadMethodCallException If no argument was provided.
-     */
-    public function hasKey()
-    {
-        $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];
-        }
-
-        return true;
-    }
-
-    /**
-     * 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()
-    {
-        $keys = $this->getKeyArguments(func_get_args());
-
-        if ( ! $this->hasKey($keys)) {
-            throw new OutOfRangeException(sprintf(_('The configuration key %1$s does not exist.'),
-                implode('->', $keys)));
-        }
-
-        $keys  = array_reverse($keys);
-        $array = $this->getArrayCopy();
-        while (count($keys) > 0) {
-            $key   = array_pop($keys);
-            $array = $array[$key];
-        }
-
-        return $array;
-    }
-
-    /**
-     * 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);
-    }
-
-    /**
-     * 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)
-    {
-        if (count($arguments) < 1) {
-            throw new BadMethodCallException(_('No configuration key was provided.'));
-        }
-
-        $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)
-    {
-        // 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;
+		}
+	}
+
+	/**
+	 * 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
+	 * @throws BadMethodCallException If no argument was provided.
+	 */
+	public function hasKey()
+	{
+		$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];
+		}
+
+		return true;
+	}
+
+	/**
+	 * 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()
+	{
+		$keys = $this->getKeyArguments(func_get_args());
+
+		if ( ! $this->hasKey($keys)) {
+			throw new OutOfRangeException(sprintf(_('The configuration key %1$s does not exist.'),
+				implode('->', $keys)));
+		}
+
+		$keys  = array_reverse($keys);
+		$array = $this->getArrayCopy();
+		while (count($keys) > 0) {
+			$key   = array_pop($keys);
+			$array = $array[$key];
+		}
+
+		return $array;
+	}
+
+	/**
+	 * 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);
+	}
+
+	/**
+	 * 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)
+	{
+		if (count($arguments) < 1) {
+			throw new BadMethodCallException(_('No configuration key was provided.'));
+		}
+
+		$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)
+	{
+		// 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();
 }

src/Config.php

Indentation +217 added lines, -217 removed lines

@@ -1,13 +1,13 @@ 
 <?php
 /**
- * Generic Config contract implementation
- *
- * @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
- */
+	 * Generic Config contract implementation
+	 *
+	 * @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;
 
@@ -30,213 +30,213 @@ 
 class Config extends AbstractConfig
 {
 
-    /**
-     * The schema of the Config file.
-     *
-     * @var Schema
-     */
-    protected $schema;
-
-    /**
-     * The Validator class that gets asked to do the validation of the config.
-     *
-     * @since 0.1.0
-     *
-     * @var Validator
-     */
-    protected $validator;
-
-    /**
-     * Instantiate the Config object.
-     *
-     * It accepts either an array with the configuration settings, or a
-     * filename pointing to a PHP file it can include.
-     *
-     * @since 0.1.0
-     * @since 0.1.6 Accepts a delimiter to parse configuration keys.
-     *
-     * @param array|string         $config    Array with settings or filename for the
-     *                                        settings file.
-     * @param Schema|null          $schema    Optional. Config that contains default
-     *                                        values that can get overwritten.
-     * @param Validator|null       $validator Optional. Validator class that does the
-     *                                        actual validation.
-     * @param string[]|string|null $delimiter A string or array of strings that are used as delimiters to parse
-     *                                        configuration keys. Defaults to "\", "/" & ".".
-     * @throws InvalidArgumentException If the config source is not a string or
-     *                                        array.
-     * @throws RuntimeException         If loading of the config source failed.
-     * @throws UnexpectedValueException If the config file is not valid.
-     */
-    public function __construct(
-        $config,
-        Schema $schema = null,
-        Validator $validator = null,
-        $delimiter = null
-    ) {
-        $this->schema    = $schema;
-        $this->validator = $validator;
-
-        // Make sure $config is either a string or array.
-        if ( ! (is_string($config) || is_array($config))) {
-            throw new InvalidArgumentException(sprintf(
-                _('Invalid configuration source: %1$s'),
-                print_r($config, true)
-            ));
-        }
-
-        if (is_string($config)) {
-            $config = $this->fetchArrayData($config);
-        }
-
-        $config = $this->resolveOptions($config);
-
-        parent::__construct($config, $delimiter);
-
-        // Finally, validate the resulting config.
-        if ( ! $this->isValid()) {
-            throw new UnexpectedValueException(sprintf(
-                _('ConfigInterface file is not valid: %1$s'),
-                print_r($config, true)
-            ));
-        }
-    }
-
-    /**
-     * Fetch array data from a string pointing to a file.
-     *
-     * @since 0.1.0
-     *
-     * @param  string $config           Filename for the settings file.
-     * @return array                    Array with configuration settings.
-     * @throws RuntimeException         If the config source is a non-existing
-     *                                  file.
-     * @throws RuntimeException         If loading of the config source failed.
-     */
-    protected function fetchArrayData($config)
-    {
-        if (is_string($config) && ! ('' === $config)) {
-
-            // $config is a valid string, make sure it is an existing file.
-            if ( ! file_exists($config)) {
-                throw new RuntimeException(sprintf(
-                    _('Non-existing configuration source: %1$s'),
-                    (string)$config
-                ));
-            }
-
-            // Try to load the file through PHP's include().
-            $configString = $config;
-            try {
-                // Make sure we don't accidentally create output.
-                ob_get_contents();
-                $config = include($configString);
-                ob_clean();
-
-                // The included should return an array.
-                if ( ! is_array($config)) {
-                    throw new RuntimeException(_('File inclusion did not return an array.'));
-                }
-            } catch (Exception $exception) {
-                throw new RuntimeException(sprintf(
-                    _('Loading from configuration source %1$s failed. Reason: %2$s'),
-                    (string)$configString,
-                    (string)$exception->getMessage()
-                ));
-            }
-        }
-
-        return (array)$config;
-    }
-
-    /**
-     * Process the passed-in defaults and merge them with the new values, while
-     * checking that all required options are set.
-     *
-     * @since 0.1.0
-     *
-     * @param array $config             Configuration settings to resolve.
-     * @return array                    Resolved configuration settings.
-     * @throws UnexpectedValueException If there are errors while resolving the
-     *                                  options.
-     */
-    protected function resolveOptions($config)
-    {
-        if ( ! $this->schema) {
-            return $config;
-        }
-
-        try {
-            $resolver = new OptionsResolver();
-            if ($this->configureOptions($resolver)) {
-                $config = $resolver->resolve($config);
-            }
-        } catch (Exception $exception) {
-            throw new UnexpectedValueException(sprintf(
-                _('Error while resolving config options: %1$s'),
-                $exception->getMessage()
-            ));
-        }
-
-        return $config;
-    }
-
-    /**
-     * Configure the possible and required options for the Config.
-     *
-     * This should return a bool to let the resolve_options() know whether the
-     * actual resolving needs to be done or not.
-     *
-     * @since 0.1.0
-     *
-     * @param OptionsResolver $resolver Reference to the OptionsResolver
-     *                                  instance.
-     * @return bool Whether to do the resolving.
-     * @throws UnexpectedValueException If there are errors while processing.
-     */
-    protected function configureOptions(OptionsResolver $resolver)
-    {
-        $defined  = $this->schema->getDefinedOptions();
-        $defaults = $this->schema->getDefaultOptions();
-        $required = $this->schema->getRequiredOptions();
-
-        if ( ! $defined && ! $defaults && ! $required) {
-            return false;
-        }
-
-        try {
-            if ($defined) {
-                $resolver->setDefined($defined);
-            }
-            if ($defaults) {
-                $resolver->setDefaults($defaults);
-            }
-            if ($required) {
-                $resolver->setRequired($required);
-            }
-        } catch (Exception $exception) {
-            throw new UnexpectedValueException(sprintf(
-                _('Error while processing config options: %1$s'),
-                $exception->getMessage()
-            ));
-        }
-
-        return true;
-    }
-
-    /**
-     * Validate the Config file.
-     *
-     * @since  0.1.0
-     *
-     * @return boolean
-     */
-    public function isValid()
-    {
-        if ($this->validator) {
-            return $this->validator->isValid($this);
-        }
-
-        return true;
-    }
+	/**
+	 * The schema of the Config file.
+	 *
+	 * @var Schema
+	 */
+	protected $schema;
+
+	/**
+	 * The Validator class that gets asked to do the validation of the config.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var Validator
+	 */
+	protected $validator;
+
+	/**
+	 * Instantiate the Config object.
+	 *
+	 * It accepts either an array with the configuration settings, or a
+	 * filename pointing to a PHP file it can include.
+	 *
+	 * @since 0.1.0
+	 * @since 0.1.6 Accepts a delimiter to parse configuration keys.
+	 *
+	 * @param array|string         $config    Array with settings or filename for the
+	 *                                        settings file.
+	 * @param Schema|null          $schema    Optional. Config that contains default
+	 *                                        values that can get overwritten.
+	 * @param Validator|null       $validator Optional. Validator class that does the
+	 *                                        actual validation.
+	 * @param string[]|string|null $delimiter A string or array of strings that are used as delimiters to parse
+	 *                                        configuration keys. Defaults to "\", "/" & ".".
+	 * @throws InvalidArgumentException If the config source is not a string or
+	 *                                        array.
+	 * @throws RuntimeException         If loading of the config source failed.
+	 * @throws UnexpectedValueException If the config file is not valid.
+	 */
+	public function __construct(
+		$config,
+		Schema $schema = null,
+		Validator $validator = null,
+		$delimiter = null
+	) {
+		$this->schema    = $schema;
+		$this->validator = $validator;
+
+		// Make sure $config is either a string or array.
+		if ( ! (is_string($config) || is_array($config))) {
+			throw new InvalidArgumentException(sprintf(
+				_('Invalid configuration source: %1$s'),
+				print_r($config, true)
+			));
+		}
+
+		if (is_string($config)) {
+			$config = $this->fetchArrayData($config);
+		}
+
+		$config = $this->resolveOptions($config);
+
+		parent::__construct($config, $delimiter);
+
+		// Finally, validate the resulting config.
+		if ( ! $this->isValid()) {
+			throw new UnexpectedValueException(sprintf(
+				_('ConfigInterface file is not valid: %1$s'),
+				print_r($config, true)
+			));
+		}
+	}
+
+	/**
+	 * Fetch array data from a string pointing to a file.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param  string $config           Filename for the settings file.
+	 * @return array                    Array with configuration settings.
+	 * @throws RuntimeException         If the config source is a non-existing
+	 *                                  file.
+	 * @throws RuntimeException         If loading of the config source failed.
+	 */
+	protected function fetchArrayData($config)
+	{
+		if (is_string($config) && ! ('' === $config)) {
+
+			// $config is a valid string, make sure it is an existing file.
+			if ( ! file_exists($config)) {
+				throw new RuntimeException(sprintf(
+					_('Non-existing configuration source: %1$s'),
+					(string)$config
+				));
+			}
+
+			// Try to load the file through PHP's include().
+			$configString = $config;
+			try {
+				// Make sure we don't accidentally create output.
+				ob_get_contents();
+				$config = include($configString);
+				ob_clean();
+
+				// The included should return an array.
+				if ( ! is_array($config)) {
+					throw new RuntimeException(_('File inclusion did not return an array.'));
+				}
+			} catch (Exception $exception) {
+				throw new RuntimeException(sprintf(
+					_('Loading from configuration source %1$s failed. Reason: %2$s'),
+					(string)$configString,
+					(string)$exception->getMessage()
+				));
+			}
+		}
+
+		return (array)$config;
+	}
+
+	/**
+	 * Process the passed-in defaults and merge them with the new values, while
+	 * checking that all required options are set.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param array $config             Configuration settings to resolve.
+	 * @return array                    Resolved configuration settings.
+	 * @throws UnexpectedValueException If there are errors while resolving the
+	 *                                  options.
+	 */
+	protected function resolveOptions($config)
+	{
+		if ( ! $this->schema) {
+			return $config;
+		}
+
+		try {
+			$resolver = new OptionsResolver();
+			if ($this->configureOptions($resolver)) {
+				$config = $resolver->resolve($config);
+			}
+		} catch (Exception $exception) {
+			throw new UnexpectedValueException(sprintf(
+				_('Error while resolving config options: %1$s'),
+				$exception->getMessage()
+			));
+		}
+
+		return $config;
+	}
+
+	/**
+	 * Configure the possible and required options for the Config.
+	 *
+	 * This should return a bool to let the resolve_options() know whether the
+	 * actual resolving needs to be done or not.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param OptionsResolver $resolver Reference to the OptionsResolver
+	 *                                  instance.
+	 * @return bool Whether to do the resolving.
+	 * @throws UnexpectedValueException If there are errors while processing.
+	 */
+	protected function configureOptions(OptionsResolver $resolver)
+	{
+		$defined  = $this->schema->getDefinedOptions();
+		$defaults = $this->schema->getDefaultOptions();
+		$required = $this->schema->getRequiredOptions();
+
+		if ( ! $defined && ! $defaults && ! $required) {
+			return false;
+		}
+
+		try {
+			if ($defined) {
+				$resolver->setDefined($defined);
+			}
+			if ($defaults) {
+				$resolver->setDefaults($defaults);
+			}
+			if ($required) {
+				$resolver->setRequired($required);
+			}
+		} catch (Exception $exception) {
+			throw new UnexpectedValueException(sprintf(
+				_('Error while processing config options: %1$s'),
+				$exception->getMessage()
+			));
+		}
+
+		return true;
+	}
+
+	/**
+	 * Validate the Config file.
+	 *
+	 * @since  0.1.0
+	 *
+	 * @return boolean
+	 */
+	public function isValid()
+	{
+		if ($this->validator) {
+			return $this->validator->isValid($this);
+		}
+
+		return true;
+	}
 }