brightnucleus / config

src/ConfigValidatorInterface.php

Indentation +10 added lines, -10 removed lines

@@ -22,14 +22,14 @@
 interface ConfigValidatorInterface
 {
 
-    /**
-     * Check whether the passed-in Config is valid.
-     *
-     * @since 0.1.0
-     *
-     * @param ConfigInterface $config
-     *
-     * @return bool
-     */
-    public function isValid(ConfigInterface $config);
+	/**
+	 * Check whether the passed-in Config is valid.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param ConfigInterface $config
+	 *
+	 * @return bool
+	 */
+	public function isValid(ConfigInterface $config);
 }

src/ConfigSchemaInterface.php

Indentation +24 added lines, -24 removed lines

@@ -22,30 +22,30 @@
 interface ConfigSchemaInterface
 {
 
-    /**
-     * Get the set of defined options.
-     *
-     * @since 0.1.0
-     *
-     * @return array|null
-     */
-    public function getDefinedOptions();
+	/**
+	 * Get the set of defined options.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return array|null
+	 */
+	public function getDefinedOptions();
 
-    /**
-     * Get the set of default options.
-     *
-     * @since 0.1.0
-     *
-     * @return array|null
-     */
-    public function getDefaultOptions();
+	/**
+	 * Get the set of default options.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return array|null
+	 */
+	public function getDefaultOptions();
 
-    /**
-     * Get the set of required options.
-     *
-     * @since 0.1.0
-     *
-     * @return array|null
-     */
-    public function getRequiredOptions();
+	/**
+	 * Get the set of required options.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return array|null
+	 */
+	public function getRequiredOptions();
 }

src/Loader/AbstractLoader.php

Indentation +64 added lines, -64 removed lines

@@ -25,72 +25,72 @@
 abstract class AbstractLoader implements LoaderInterface
 {
 
-    /**
-     * Load the configuration from an URI.
-     *
-     * @since 0.4.0
-     *
-     * @param string $uri URI of the resource to load.
-     *
-     * @return array|null Data contained within the resource. Null if no data could be loaded/parsed.
-     * @throws FailedToLoadConfigException If the configuration could not be loaded.
-     */
-    public function load($uri)
-    {
-        try {
-            $uri  = $this->validateUri($uri);
-            $data = $this->loadUri($uri);
+	/**
+	 * Load the configuration from an URI.
+	 *
+	 * @since 0.4.0
+	 *
+	 * @param string $uri URI of the resource to load.
+	 *
+	 * @return array|null Data contained within the resource. Null if no data could be loaded/parsed.
+	 * @throws FailedToLoadConfigException If the configuration could not be loaded.
+	 */
+	public function load($uri)
+	{
+		try {
+			$uri  = $this->validateUri($uri);
+			$data = $this->loadUri($uri);
 
-            return $this->parseData($data);
-        } catch (Exception $exception) {
-            throw new FailedToLoadConfigException(
-                sprintf(
-                    _('Could not load resource located at "%1$s". Reason: "%2$s".'),
-                    $uri,
-                    $exception->getMessage()
-                ),
-                $exception->getCode(),
-                $exception
-            );
-        }
-    }
+			return $this->parseData($data);
+		} catch (Exception $exception) {
+			throw new FailedToLoadConfigException(
+				sprintf(
+					_('Could not load resource located at "%1$s". Reason: "%2$s".'),
+					$uri,
+					$exception->getMessage()
+				),
+				$exception->getCode(),
+				$exception
+			);
+		}
+	}
 
-    /**
-     * Validate and return the URI.
-     *
-     * @since 0.4.0
-     *
-     * @param string $uri URI of the resource to load.
-     *
-     * @return string Validated URI.
-     */
-    protected function validateUri($uri)
-    {
-        return $uri;
-    }
+	/**
+	 * Validate and return the URI.
+	 *
+	 * @since 0.4.0
+	 *
+	 * @param string $uri URI of the resource to load.
+	 *
+	 * @return string Validated URI.
+	 */
+	protected function validateUri($uri)
+	{
+		return $uri;
+	}
 
-    /**
-     * Parse the raw data and return it in parsed form.
-     *
-     * @since 0.4.0
-     *
-     * @param array|null $data Raw data to be parsed.
-     *
-     * @return array|null Data in parsed form. Null if no parsable data found.
-     */
-    protected function parseData($data)
-    {
-        return $data;
-    }
+	/**
+	 * Parse the raw data and return it in parsed form.
+	 *
+	 * @since 0.4.0
+	 *
+	 * @param array|null $data Raw data to be parsed.
+	 *
+	 * @return array|null Data in parsed form. Null if no parsable data found.
+	 */
+	protected function parseData($data)
+	{
+		return $data;
+	}
 
-    /**
-     * Load the contents of an resource identified by an URI.
-     *
-     * @since 0.4.0
-     *
-     * @param string $uri URI of the resource.
-     *
-     * @return array|null Raw data loaded from the resource. Null if no data found.
-     */
-    abstract protected function loadUri($uri);
+	/**
+	 * Load the contents of an resource identified by an URI.
+	 *
+	 * @since 0.4.0
+	 *
+	 * @param string $uri URI of the resource.
+	 *
+	 * @return array|null Raw data loaded from the resource. Null if no data found.
+	 */
+	abstract protected function loadUri($uri);
 }

src/AbstractConfigSchema.php

Indentation +69 added lines, -69 removed lines

@@ -22,84 +22,84 @@
 abstract class AbstractConfigSchema implements ConfigSchemaInterface
 {
 
-    /**
-     * The defined values that are recognized.
-     *
-     * @var ConfigInterface
-     */
-    protected $defined;
+	/**
+	 * The defined values that are recognized.
+	 *
+	 * @var ConfigInterface
+	 */
+	protected $defined;
 
-    /**
-     * The default values that can be overwritten.
-     *
-     * @var ConfigInterface
-     */
-    protected $defaults;
+	/**
+	 * The default values that can be overwritten.
+	 *
+	 * @var ConfigInterface
+	 */
+	protected $defaults;
 
-    /**
-     * The required values that need to be set.
-     *
-     * @var ConfigInterface
-     */
-    protected $required;
+	/**
+	 * The required values that need to be set.
+	 *
+	 * @var ConfigInterface
+	 */
+	protected $required;
 
-    /**
-     * Get the set of defined options.
-     *
-     * @since 0.1.0
-     *
-     * @return array|null
-     */
-    public function getDefinedOptions()
-    {
-        if (! $this->defined) {
-            return null;
-        }
+	/**
+	 * Get the set of defined options.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return array|null
+	 */
+	public function getDefinedOptions()
+	{
+		if (! $this->defined) {
+			return null;
+		}
 
-        if ($this->defined instanceof ConfigInterface) {
-            return $this->defined->getArrayCopy();
-        }
+		if ($this->defined instanceof ConfigInterface) {
+			return $this->defined->getArrayCopy();
+		}
 
-        return (array)$this->defined;
-    }
+		return (array)$this->defined;
+	}
 
-    /**
-     * Get the set of default options.
-     *
-     * @since 0.1.0
-     *
-     * @return array|null
-     */
-    public function getDefaultOptions()
-    {
-        if (! $this->defaults) {
-            return null;
-        }
+	/**
+	 * Get the set of default options.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return array|null
+	 */
+	public function getDefaultOptions()
+	{
+		if (! $this->defaults) {
+			return null;
+		}
 
-        if ($this->defaults instanceof ConfigInterface) {
-            return $this->defaults->getArrayCopy();
-        }
+		if ($this->defaults instanceof ConfigInterface) {
+			return $this->defaults->getArrayCopy();
+		}
 
-        return (array)$this->defaults;
-    }
+		return (array)$this->defaults;
+	}
 
-    /**
-     * Get the set of required options.
-     *
-     * @since 0.1.0
-     *
-     * @return array|null
-     */
-    public function getRequiredOptions()
-    {
-        if (! $this->required) {
-            return null;
-        }
+	/**
+	 * Get the set of required options.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return array|null
+	 */
+	public function getRequiredOptions()
+	{
+		if (! $this->required) {
+			return null;
+		}
 
-        if ($this->required instanceof ConfigInterface) {
-            return $this->required->getArrayCopy();
-        }
+		if ($this->required instanceof ConfigInterface) {
+			return $this->required->getArrayCopy();
+		}
 
-        return (array)$this->required;
-    }
+		return (array)$this->required;
+	}
 }

src/ConfigSchema.php

Indentation +120 added lines, -120 removed lines

@@ -24,135 +24,135 @@
 class ConfigSchema extends AbstractConfigSchema
 {
 
-    /**
-     * The key that is used in the schema to define a default value.
-     */
-    const DEFAULT_VALUE = 'default';
-    /**
-     * The key that is used in the schema to define a required value.
-     */
-    const REQUIRED_KEY = 'required';
+	/**
+	 * The key that is used in the schema to define a default value.
+	 */
+	const DEFAULT_VALUE = 'default';
+	/**
+	 * The key that is used in the schema to define a required value.
+	 */
+	const REQUIRED_KEY = 'required';
 
-    /**
-     * Instantiate a ConfigSchema object.
-     *
-     * @since 0.1.0
-     *
-     * @param ConfigInterface|array $schema The schema to parse.
-     *
-     * @throws InvalidArgumentException
-     */
-    public function __construct($schema)
-    {
-        if ($schema instanceof ConfigInterface) {
-            $schema = $schema->getArrayCopy();
-        }
+	/**
+	 * Instantiate a ConfigSchema object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param ConfigInterface|array $schema The schema to parse.
+	 *
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($schema)
+	{
+		if ($schema instanceof ConfigInterface) {
+			$schema = $schema->getArrayCopy();
+		}
 
-        if (! is_array($schema)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    _('Invalid schema source: %1$s'),
-                    print_r($schema, true)
-                )
-            );
-        }
+		if (! is_array($schema)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					_('Invalid schema source: %1$s'),
+					print_r($schema, true)
+				)
+			);
+		}
 
-        array_walk($schema, [$this, 'parseSchema']);
-    }
+		array_walk($schema, [$this, 'parseSchema']);
+	}
 
-    /**
-     * Parse a single provided schema entry.
-     *
-     * @since 0.1.0
-     *
-     * @param mixed  $data The data associated with the key.
-     * @param string $key  The key of the schema data.
-     */
-    protected function parseSchema($data, $key)
-    {
-        $this->parseDefined($key);
+	/**
+	 * Parse a single provided schema entry.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param mixed  $data The data associated with the key.
+	 * @param string $key  The key of the schema data.
+	 */
+	protected function parseSchema($data, $key)
+	{
+		$this->parseDefined($key);
 
-        if (array_key_exists(self::REQUIRED_KEY, $data)) {
-            $this->parseRequired(
-                $key,
-                $data[self::REQUIRED_KEY]
-            );
-        }
+		if (array_key_exists(self::REQUIRED_KEY, $data)) {
+			$this->parseRequired(
+				$key,
+				$data[self::REQUIRED_KEY]
+			);
+		}
 
-        if (array_key_exists(self::DEFAULT_VALUE, $data)) {
-            $this->parseDefault(
-                $key,
-                $data[self::DEFAULT_VALUE]
-            );
-        }
-    }
+		if (array_key_exists(self::DEFAULT_VALUE, $data)) {
+			$this->parseDefault(
+				$key,
+				$data[self::DEFAULT_VALUE]
+			);
+		}
+	}
 
-    /**
-     * Parse the set of defined values.
-     *
-     * @since 0.1.0
-     *
-     * @param string $key The key of the schema data.
-     */
-    protected function parseDefined($key)
-    {
-        $this->defined[] = $key;
-    }
+	/**
+	 * Parse the set of defined values.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string $key The key of the schema data.
+	 */
+	protected function parseDefined($key)
+	{
+		$this->defined[] = $key;
+	}
 
-    /**
-     * Parse the set of required values.
-     *
-     * @since 0.1.0
-     *
-     * @param string $key  The key of the schema data.
-     * @param mixed  $data The data associated with the key.
-     */
-    protected function parseRequired($key, $data)
-    {
-        if ($this->isTruthy($data)) {
-            $this->required[] = $key;
-        }
-    }
+	/**
+	 * Parse the set of required values.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string $key  The key of the schema data.
+	 * @param mixed  $data The data associated with the key.
+	 */
+	protected function parseRequired($key, $data)
+	{
+		if ($this->isTruthy($data)) {
+			$this->required[] = $key;
+		}
+	}
 
-    /**
-     * Parse the set of default values.
-     *
-     * @since 0.1.0
-     *
-     * @param string $key  The key of the schema data.
-     * @param mixed  $data The data associated with the key.
-     */
-    protected function parseDefault($key, $data)
-    {
-        $this->defaults[$key] = $data;
-    }
+	/**
+	 * Parse the set of default values.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string $key  The key of the schema data.
+	 * @param mixed  $data The data associated with the key.
+	 */
+	protected function parseDefault($key, $data)
+	{
+		$this->defaults[$key] = $data;
+	}
 
-    /**
-     * Return a boolean true or false for an arbitrary set of data. Recognizes
-     * several different string values that should be valued as true.
-     *
-     * @since 0.1.0
-     *
-     * @param mixed $data The data to evaluate.
-     *
-     * @return bool
-     */
-    protected function isTruthy($data)
-    {
-        $truthy_values = [
-            true,
-            1,
-            'true',
-            'True',
-            'TRUE',
-            'y',
-            'Y',
-            'yes',
-            'Yes',
-            'YES',
-            '√',
-        ];
+	/**
+	 * Return a boolean true or false for an arbitrary set of data. Recognizes
+	 * several different string values that should be valued as true.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param mixed $data The data to evaluate.
+	 *
+	 * @return bool
+	 */
+	protected function isTruthy($data)
+	{
+		$truthy_values = [
+			true,
+			1,
+			'true',
+			'True',
+			'TRUE',
+			'y',
+			'Y',
+			'yes',
+			'Yes',
+			'YES',
+			'√',
+		];
 
-        return in_array($data, $truthy_values, true);
-    }
+		return in_array($data, $truthy_values, true);
+	}
 }

src/Loader.php

Indentation +15 added lines, -15 removed lines

@@ -25,20 +25,20 @@
 class Loader
 {
 
-    /**
-     * Static convenience function to load a configuration from an URI.
-     *
-     * @since 0.4.0
-     *
-     * @param string $uri URI of the resource to load.
-     *
-     * @return array|null Parsed data loaded from the resource.
-     * @throws FailedToLoadConfigException If the configuration could not be loaded.
-     */
-    public static function load($uri)
-    {
-        $loader = LoaderFactory::createFromUri($uri);
+	/**
+	 * Static convenience function to load a configuration from an URI.
+	 *
+	 * @since 0.4.0
+	 *
+	 * @param string $uri URI of the resource to load.
+	 *
+	 * @return array|null Parsed data loaded from the resource.
+	 * @throws FailedToLoadConfigException If the configuration could not be loaded.
+	 */
+	public static function load($uri)
+	{
+		$loader = LoaderFactory::createFromUri($uri);
 
-        return $loader->load($uri);
-    }
+		return $loader->load($uri);
+	}
 }

src/AbstractConfig.php

Indentation +217 added lines, -217 removed lines

@@ -26,221 +26,221 @@
 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 KeyNotFoundException 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 KeyNotFoundException 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 KeyNotFoundException If an unknown key is requested.
-     */
-    public function validateKeys($_)
-    {
-        $keys = $this->getKeyArguments(func_get_args());
-
-        if (! $this->hasKey($keys)) {
-            throw new KeyNotFoundException(
-                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.
-     */
-    protected function getKeyArguments($arguments)
-    {
-        $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;
+		}
+	}
+
+	/**
+	 * 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 KeyNotFoundException 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 KeyNotFoundException 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 KeyNotFoundException If an unknown key is requested.
+	 */
+	public function validateKeys($_)
+	{
+		$keys = $this->getKeyArguments(func_get_args());
+
+		if (! $this->hasKey($keys)) {
+			throw new KeyNotFoundException(
+				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.
+	 */
+	protected function getKeyArguments($arguments)
+	{
+		$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/ConfigTrait.php

Indentation +160 added lines, -160 removed lines

@@ -25,164 +25,164 @@
 trait ConfigTrait
 {
 
-    /**
-     * 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 FailedToProcessConfigException 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 FailedToProcessConfigException(
-                    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();
-
-        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();
-
-        return $this->config->getKey($keys);
-    }
-
-    /**
-     * Get the callable Config value for a specific key.
-     *
-     * If the fetched value is indeed a callable, it will be executed with the provided arguments, and the resultant
-     * value will be returned instead.
-     *
-     * @since 0.4.8
-     *
-     * @param string|array $key  Key or array of nested keys.
-     * @param array        $args Optional. Array of arguments to pass to the callable.
-     *
-     * @return mixed Resultant value of the key's callable.
-     */
-    protected function getConfigCallable($key, array $args = [])
-    {
-        $value = $this->config->getKey($key);
-
-        if (is_callable($value)) {
-            $value = $value(...$args);
-        }
-
-        return $value;
-    }
-
-    /**
-     * 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 a default configuration in case none was injected into the constructor.
-     *
-     * The name and path of the configuration needs to be set as a const called DEFAULT_CONFIG within the class
-     * containing the trait. The path needs to be relative to the location of the containing class file.
-     *
-     * @since 0.4.2
-     *
-     * @return ConfigInterface Configuration settings to use.
-     */
-    protected function fetchDefaultConfig()
-    {
-        $configFile = method_exists($this, 'getDefaultConfigFile')
-            ? $this->getDefaultConfigFile()
-            : __DIR__ . '/../config/defaults.php';
-
-        return $this->fetchConfig($configFile);
-    }
-
-    /**
-     * Get a configuration from a specified $file.
-     *
-     * If file is not accessible or readable, returns an empty Config.
-     *
-     * @since 0.4.2
-     *
-     * @return ConfigInterface Configuration settings to use.
-     */
-    protected function fetchConfig($configFile)
-    {
-        if (is_string($configFile) && ! is_readable($configFile)) {
-            $configFile = [];
-        }
-
-        return ConfigFactory::create($configFile);
-    }
+	/**
+	 * 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 FailedToProcessConfigException 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 FailedToProcessConfigException(
+					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();
+
+		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();
+
+		return $this->config->getKey($keys);
+	}
+
+	/**
+	 * Get the callable Config value for a specific key.
+	 *
+	 * If the fetched value is indeed a callable, it will be executed with the provided arguments, and the resultant
+	 * value will be returned instead.
+	 *
+	 * @since 0.4.8
+	 *
+	 * @param string|array $key  Key or array of nested keys.
+	 * @param array        $args Optional. Array of arguments to pass to the callable.
+	 *
+	 * @return mixed Resultant value of the key's callable.
+	 */
+	protected function getConfigCallable($key, array $args = [])
+	{
+		$value = $this->config->getKey($key);
+
+		if (is_callable($value)) {
+			$value = $value(...$args);
+		}
+
+		return $value;
+	}
+
+	/**
+	 * 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 a default configuration in case none was injected into the constructor.
+	 *
+	 * The name and path of the configuration needs to be set as a const called DEFAULT_CONFIG within the class
+	 * containing the trait. The path needs to be relative to the location of the containing class file.
+	 *
+	 * @since 0.4.2
+	 *
+	 * @return ConfigInterface Configuration settings to use.
+	 */
+	protected function fetchDefaultConfig()
+	{
+		$configFile = method_exists($this, 'getDefaultConfigFile')
+			? $this->getDefaultConfigFile()
+			: __DIR__ . '/../config/defaults.php';
+
+		return $this->fetchConfig($configFile);
+	}
+
+	/**
+	 * Get a configuration from a specified $file.
+	 *
+	 * If file is not accessible or readable, returns an empty Config.
+	 *
+	 * @since 0.4.2
+	 *
+	 * @return ConfigInterface Configuration settings to use.
+	 */
+	protected function fetchConfig($configFile)
+	{
+		if (is_string($configFile) && ! is_readable($configFile)) {
+			$configFile = [];
+		}
+
+		return ConfigFactory::create($configFile);
+	}
 }

src/Loader/LoaderFactory.php

Indentation +87 added lines, -87 removed lines

@@ -25,98 +25,98 @@
 class LoaderFactory
 {
 
-    /**
-     * Array of fully qualified class names of known loaders.
-     *
-     * @var array<string>
-     *
-     * @since 0.4.0
-     */
-    protected static $loaders = [
-        'BrightNucleus\Config\Loader\PHPLoader',
-        'BrightNucleus\Config\Loader\JSONLoader',
-    ];
+	/**
+	 * Array of fully qualified class names of known loaders.
+	 *
+	 * @var array<string>
+	 *
+	 * @since 0.4.0
+	 */
+	protected static $loaders = [
+		'BrightNucleus\Config\Loader\PHPLoader',
+		'BrightNucleus\Config\Loader\JSONLoader',
+	];
 
-    /**
-     * Array of instantiated loaders.
-     *
-     * These are lazily instantiated and added as needed.
-     *
-     * @var LoaderInterface[]
-     *
-     * @since 0.4.0
-     */
-    protected static $loaderInstances = [];
+	/**
+	 * Array of instantiated loaders.
+	 *
+	 * These are lazily instantiated and added as needed.
+	 *
+	 * @var LoaderInterface[]
+	 *
+	 * @since 0.4.0
+	 */
+	protected static $loaderInstances = [];
 
-    /**
-     * Create a new Loader from an URI.
-     *
-     * @since 0.4.0
-     *
-     * @param string $uri URI of the resource to create a loader for.
-     *
-     * @return LoaderInterface Loader that is able to load the given URI.
-     * @throws FailedToLoadConfigException If no suitable loader was found.
-     */
-    public static function createFromUri($uri)
-    {
-        foreach (static::$loaders as $loader) {
-            if ($loader::canLoad($uri)) {
-                return static::getLoader($loader);
-            }
-        }
+	/**
+	 * Create a new Loader from an URI.
+	 *
+	 * @since 0.4.0
+	 *
+	 * @param string $uri URI of the resource to create a loader for.
+	 *
+	 * @return LoaderInterface Loader that is able to load the given URI.
+	 * @throws FailedToLoadConfigException If no suitable loader was found.
+	 */
+	public static function createFromUri($uri)
+	{
+		foreach (static::$loaders as $loader) {
+			if ($loader::canLoad($uri)) {
+				return static::getLoader($loader);
+			}
+		}
 
-        throw new FailedToLoadConfigException(
-            sprintf(
-                _('Could not find a suitable loader for URI "%1$s".'),
-                $uri
-            )
-        );
-    }
+		throw new FailedToLoadConfigException(
+			sprintf(
+				_('Could not find a suitable loader for URI "%1$s".'),
+				$uri
+			)
+		);
+	}
 
-    /**
-     * Get an instance of a specific loader.
-     *
-     * The loader is lazily instantiated if needed.
-     *
-     * @since 0.4.0
-     *
-     * @param string $loaderClass Fully qualified class name of the loader to get.
-     *
-     * @return LoaderInterface Instance of the requested loader.
-     * @throws FailedToLoadConfigException If the loader class could not be instantiated.
-     */
-    public static function getLoader($loaderClass)
-    {
-        try {
-            if (! array_key_exists($loaderClass, static::$loaderInstances)) {
-                static::$loaderInstances[$loaderClass] = new $loaderClass;
-            }
+	/**
+	 * Get an instance of a specific loader.
+	 *
+	 * The loader is lazily instantiated if needed.
+	 *
+	 * @since 0.4.0
+	 *
+	 * @param string $loaderClass Fully qualified class name of the loader to get.
+	 *
+	 * @return LoaderInterface Instance of the requested loader.
+	 * @throws FailedToLoadConfigException If the loader class could not be instantiated.
+	 */
+	public static function getLoader($loaderClass)
+	{
+		try {
+			if (! array_key_exists($loaderClass, static::$loaderInstances)) {
+				static::$loaderInstances[$loaderClass] = new $loaderClass;
+			}
 
-            return static::$loaderInstances[$loaderClass];
-        } catch (Exception $exception) {
-            throw new FailedToLoadConfigException(
-                sprintf(
-                    _('Could not instantiate the requested loader class "%1$s".'),
-                    $loaderClass
-                )
-            );
-        }
-    }
+			return static::$loaderInstances[$loaderClass];
+		} catch (Exception $exception) {
+			throw new FailedToLoadConfigException(
+				sprintf(
+					_('Could not instantiate the requested loader class "%1$s".'),
+					$loaderClass
+				)
+			);
+		}
+	}
 
-    /**
-     * Register a new loader.
-     *
-     * @since 0.4.0
-     *
-     * @param string $loader Fully qualified class name of a loader implementing LoaderInterface.
-     */
-    public static function registerLoader($loader)
-    {
-        if (in_array($loader, static::$loaders, true)) {
-            return;
-        }
+	/**
+	 * Register a new loader.
+	 *
+	 * @since 0.4.0
+	 *
+	 * @param string $loader Fully qualified class name of a loader implementing LoaderInterface.
+	 */
+	public static function registerLoader($loader)
+	{
+		if (in_array($loader, static::$loaders, true)) {
+			return;
+		}
 
-        static::$loaders [] = $loader;
-    }
+		static::$loaders [] = $loader;
+	}
 }