brightnucleus / config

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/ConfigFactory.php

Indentation +222 added lines, -222 removed lines

@@ -24,226 +24,226 @@
 class ConfigFactory
 {
 
-    /**
-     * Cached contents of the config files.
-     *
-     * @since 0.4.3
-     *
-     * @var array
-     */
-    protected static $configFilesCache = [];
-
-    /**
-     * Create a new ConfigInterface object from a file.
-     *
-     * If a comma-separated list of files is provided, they are checked in sequence until the first one could be loaded
-     * successfully.
-     *
-     * @since 0.3.0
-     *
-     * @param string|array $_ List of files.
-     *
-     * @return ConfigInterface Instance of a ConfigInterface implementation.
-     */
-    public static function createFromFile($_)
-    {
-        $files = array_reverse(func_get_args());
-
-        if (is_array($files[0])) {
-            $files = $files[0];
-        }
-
-        while (count($files) > 0) {
-            try {
-                $file = array_pop($files);
-
-                if (! is_readable($file)) {
-                    continue;
-                }
-
-                $config = static::createFromArray(
-                    static::getFromCache($file, function ($file) {
-                        return Loader::load($file);
-                    })
-                );
-
-                if (null === $config) {
-                    continue;
-                }
-
-                return $config;
-            } catch (Exception $exception) {
-                // Fail silently and try next file.
-            }
-        }
-
-        return static::createFromArray([]);
-    }
-
-    /**
-     * Create a new ConfigInterface object from an array.
-     *
-     * @since 0.3.0
-     *
-     * @param array $array Array with configuration values.
-     *
-     * @return ConfigInterface Instance of a ConfigInterface implementation.
-     */
-    public static function createFromArray(array $array)
-    {
-        try {
-            return new Config($array);
-        } catch (Exception $exception) {
-            // Fail silently and try next file.
-        }
-
-        return null;
-    }
-
-    /**
-     * Create a new ConfigInterface object.
-     *
-     * Tries to deduce the correct creation method by inspecting the provided arguments.
-     *
-     * @since 0.3.0
-     *
-     * @param mixed $_ Array with configuration values.
-     *
-     * @return ConfigInterface Instance of a ConfigInterface implementation.
-     */
-    public static function create($_)
-    {
-        if (func_num_args() < 1) {
-            return static::createFromArray([]);
-        }
-
-        $arguments = func_get_args();
-
-        if (is_array($arguments[0]) && func_num_args() === 1) {
-            return static::createFromArray($arguments[0]);
-        }
-
-        return static::createFromFile($arguments);
-    }
-
-    /**
-     * Create a new ConfigInterface object, by merging several files together.
-     *
-     * Duplicate keys in later files will override those in earlier files.
-     *
-     * @since 0.4.6
-     *
-     * @param mixed $_ Array with configuration values.
-     *
-     * @return ConfigInterface Instance of a ConfigInterface implementation.
-     */
-    public static function merge($_)
-    {
-        if (func_num_args() < 1) {
-            return static::createFromArray([]);
-        }
-
-        $arguments = func_get_args();
-
-        if (is_array($arguments[0]) && func_num_args() === 1) {
-            return static::createFromArray($arguments[0]);
-        }
-
-        return static::mergeFromFiles($arguments);
-    }
-
-    /**
-     * Create a new ConfigInterface object by merging data from several files.
-     *
-     * If a comma-separated list of files is provided, they are loaded in sequence and later files override settings in
-     * earlier files.
-     *
-     * @since 0.4.6
-     *
-     * @param string|array $_ List of files.
-     *
-     * @return ConfigInterface Instance of a ConfigInterface implementation.
-     */
-    public static function mergeFromFiles($_)
-    {
-        $files = array_reverse(func_get_args());
-        $data  = [];
-
-        if (is_array($files[0])) {
-            $files = array_reverse($files[0]);
-        }
-
-        while (count($files) > 0) {
-            try {
-                $file = array_pop($files);
-
-                if (! is_readable($file)) {
-                    continue;
-                }
-
-                $new_data = static::getFromCache($file, function ($file) {
-                    return Loader::load($file);
-                });
-
-                if (null === $data) {
-                    continue;
-                }
-
-                $data = array_replace_recursive($data, $new_data);
-            } catch (Exception $exception) {
-                // Fail silently and try next file.
-            }
-        }
-
-        return static::createFromArray($data);
-    }
-
-    /**
-     * Create a new ConfigInterface object from a file and return a sub-portion of it.
-     *
-     * The first argument needs to be the file name to load, and the subsequent arguments will be passed on to
-     * `Config::getSubConfig()`.
-     *
-     * @since 0.4.5
-     *
-     * @param mixed $_ File name of the config to load as a string, followed by an array of keys to pass to
-     *                 `Config::getSubConfig()`.
-     *
-     * @return ConfigInterface Instance of a ConfigInterface implementation.
-     */
-    public static function createSubConfig($_)
-    {
-        if (func_num_args() < 2) {
-            return static::createFromArray([]);
-        }
-
-        $arguments = func_get_args();
-        $file      = array_shift($arguments);
-
-        $config = static::createFromFile($file);
-
-        return $config->getSubConfig($arguments);
-    }
-
-    /**
-     * Get a config file from the config file cache.
-     *
-     * @since 0.4.4
-     *
-     * @param string $identifier Identifier to look for in the cache.
-     * @param mixed  $fallback   Fallback to use to fill the cache. If $fallback is a callable, it will be executed
-     *                           with $identifier as an argument.
-     *
-     * @return mixed The latest content of the cache for the given identifier.
-     */
-    protected static function getFromCache($identifier, $fallback)
-    {
-        if (! array_key_exists($identifier, static::$configFilesCache)) {
-            static::$configFilesCache[$identifier] = is_callable($fallback)
-                ? $fallback($identifier)
-                : $fallback;
-        }
-
-        return static::$configFilesCache[$identifier];
-    }
+	/**
+	 * Cached contents of the config files.
+	 *
+	 * @since 0.4.3
+	 *
+	 * @var array
+	 */
+	protected static $configFilesCache = [];
+
+	/**
+	 * Create a new ConfigInterface object from a file.
+	 *
+	 * If a comma-separated list of files is provided, they are checked in sequence until the first one could be loaded
+	 * successfully.
+	 *
+	 * @since 0.3.0
+	 *
+	 * @param string|array $_ List of files.
+	 *
+	 * @return ConfigInterface Instance of a ConfigInterface implementation.
+	 */
+	public static function createFromFile($_)
+	{
+		$files = array_reverse(func_get_args());
+
+		if (is_array($files[0])) {
+			$files = $files[0];
+		}
+
+		while (count($files) > 0) {
+			try {
+				$file = array_pop($files);
+
+				if (! is_readable($file)) {
+					continue;
+				}
+
+				$config = static::createFromArray(
+					static::getFromCache($file, function ($file) {
+						return Loader::load($file);
+					})
+				);
+
+				if (null === $config) {
+					continue;
+				}
+
+				return $config;
+			} catch (Exception $exception) {
+				// Fail silently and try next file.
+			}
+		}
+
+		return static::createFromArray([]);
+	}
+
+	/**
+	 * Create a new ConfigInterface object from an array.
+	 *
+	 * @since 0.3.0
+	 *
+	 * @param array $array Array with configuration values.
+	 *
+	 * @return ConfigInterface Instance of a ConfigInterface implementation.
+	 */
+	public static function createFromArray(array $array)
+	{
+		try {
+			return new Config($array);
+		} catch (Exception $exception) {
+			// Fail silently and try next file.
+		}
+
+		return null;
+	}
+
+	/**
+	 * Create a new ConfigInterface object.
+	 *
+	 * Tries to deduce the correct creation method by inspecting the provided arguments.
+	 *
+	 * @since 0.3.0
+	 *
+	 * @param mixed $_ Array with configuration values.
+	 *
+	 * @return ConfigInterface Instance of a ConfigInterface implementation.
+	 */
+	public static function create($_)
+	{
+		if (func_num_args() < 1) {
+			return static::createFromArray([]);
+		}
+
+		$arguments = func_get_args();
+
+		if (is_array($arguments[0]) && func_num_args() === 1) {
+			return static::createFromArray($arguments[0]);
+		}
+
+		return static::createFromFile($arguments);
+	}
+
+	/**
+	 * Create a new ConfigInterface object, by merging several files together.
+	 *
+	 * Duplicate keys in later files will override those in earlier files.
+	 *
+	 * @since 0.4.6
+	 *
+	 * @param mixed $_ Array with configuration values.
+	 *
+	 * @return ConfigInterface Instance of a ConfigInterface implementation.
+	 */
+	public static function merge($_)
+	{
+		if (func_num_args() < 1) {
+			return static::createFromArray([]);
+		}
+
+		$arguments = func_get_args();
+
+		if (is_array($arguments[0]) && func_num_args() === 1) {
+			return static::createFromArray($arguments[0]);
+		}
+
+		return static::mergeFromFiles($arguments);
+	}
+
+	/**
+	 * Create a new ConfigInterface object by merging data from several files.
+	 *
+	 * If a comma-separated list of files is provided, they are loaded in sequence and later files override settings in
+	 * earlier files.
+	 *
+	 * @since 0.4.6
+	 *
+	 * @param string|array $_ List of files.
+	 *
+	 * @return ConfigInterface Instance of a ConfigInterface implementation.
+	 */
+	public static function mergeFromFiles($_)
+	{
+		$files = array_reverse(func_get_args());
+		$data  = [];
+
+		if (is_array($files[0])) {
+			$files = array_reverse($files[0]);
+		}
+
+		while (count($files) > 0) {
+			try {
+				$file = array_pop($files);
+
+				if (! is_readable($file)) {
+					continue;
+				}
+
+				$new_data = static::getFromCache($file, function ($file) {
+					return Loader::load($file);
+				});
+
+				if (null === $data) {
+					continue;
+				}
+
+				$data = array_replace_recursive($data, $new_data);
+			} catch (Exception $exception) {
+				// Fail silently and try next file.
+			}
+		}
+
+		return static::createFromArray($data);
+	}
+
+	/**
+	 * Create a new ConfigInterface object from a file and return a sub-portion of it.
+	 *
+	 * The first argument needs to be the file name to load, and the subsequent arguments will be passed on to
+	 * `Config::getSubConfig()`.
+	 *
+	 * @since 0.4.5
+	 *
+	 * @param mixed $_ File name of the config to load as a string, followed by an array of keys to pass to
+	 *                 `Config::getSubConfig()`.
+	 *
+	 * @return ConfigInterface Instance of a ConfigInterface implementation.
+	 */
+	public static function createSubConfig($_)
+	{
+		if (func_num_args() < 2) {
+			return static::createFromArray([]);
+		}
+
+		$arguments = func_get_args();
+		$file      = array_shift($arguments);
+
+		$config = static::createFromFile($file);
+
+		return $config->getSubConfig($arguments);
+	}
+
+	/**
+	 * Get a config file from the config file cache.
+	 *
+	 * @since 0.4.4
+	 *
+	 * @param string $identifier Identifier to look for in the cache.
+	 * @param mixed  $fallback   Fallback to use to fill the cache. If $fallback is a callable, it will be executed
+	 *                           with $identifier as an argument.
+	 *
+	 * @return mixed The latest content of the cache for the given identifier.
+	 */
+	protected static function getFromCache($identifier, $fallback)
+	{
+		if (! array_key_exists($identifier, static::$configFilesCache)) {
+			static::$configFilesCache[$identifier] = is_callable($fallback)
+				? $fallback($identifier)
+				: $fallback;
+		}
+
+		return static::$configFilesCache[$identifier];
+	}
 }

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/JSONLoader.php

Indentation +67 added lines, -67 removed lines

@@ -25,76 +25,76 @@
 class JSONLoader extends AbstractLoader
 {
 
-    /**
-     * Load the configuration from an URI.
-     *
-     * @since 0.4.0
-     *
-     * @param string $uri URI of the resource to load.
-     *
-     * @return array Data contained within the resource.
-     */
-    public static function canLoad($uri)
-    {
-        $path = pathinfo($uri);
+	/**
+	 * Load the configuration from an URI.
+	 *
+	 * @since 0.4.0
+	 *
+	 * @param string $uri URI of the resource to load.
+	 *
+	 * @return array Data contained within the resource.
+	 */
+	public static function canLoad($uri)
+	{
+		$path = pathinfo($uri);
 
-        return 'json' === mb_strtolower($path['extension']);
-    }
+		return 'json' === mb_strtolower($path['extension']);
+	}
 
-    /**
-     * 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.
-     * @throws FailedToLoadConfigException If the resource could not be loaded.
-     */
-    protected function loadUri($uri)
-    {
-        try {
-            // Try to load the file through PHP's include().
-            // Make sure we don't accidentally create output.
-            ob_start();
-            $data = json_decode(file_get_contents($uri));
-            ob_end_clean();
+	/**
+	 * 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.
+	 * @throws FailedToLoadConfigException If the resource could not be loaded.
+	 */
+	protected function loadUri($uri)
+	{
+		try {
+			// Try to load the file through PHP's include().
+			// Make sure we don't accidentally create output.
+			ob_start();
+			$data = json_decode(file_get_contents($uri));
+			ob_end_clean();
 
-            return (array)$data;
-        } catch (Exception $exception) {
-            throw new FailedToLoadConfigException(
-                sprintf(
-                    _('Could not include PHP config file "%1$s". Reason: "%2$s".'),
-                    $uri,
-                    $exception->getMessage()
-                ),
-                $exception->getCode(),
-                $exception
-            );
-        }
-    }
+			return (array)$data;
+		} catch (Exception $exception) {
+			throw new FailedToLoadConfigException(
+				sprintf(
+					_('Could not include PHP config file "%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.
-     * @throws FailedToLoadConfigException If the URI does not exist or is not readable.
-     */
-    protected function validateUri($uri)
-    {
-        if (! is_readable($uri)) {
-            throw new FailedToLoadConfigException(
-                sprintf(
-                    _('The requested PHP config file "%1$s" does not exist or is not readable.'),
-                    $uri
-                )
-            );
-        }
+	/**
+	 * Validate and return the URI.
+	 *
+	 * @since 0.4.0
+	 *
+	 * @param string $uri URI of the resource to load.
+	 *
+	 * @return string Validated URI.
+	 * @throws FailedToLoadConfigException If the URI does not exist or is not readable.
+	 */
+	protected function validateUri($uri)
+	{
+		if (! is_readable($uri)) {
+			throw new FailedToLoadConfigException(
+				sprintf(
+					_('The requested PHP config file "%1$s" does not exist or is not readable.'),
+					$uri
+				)
+			);
+		}
 
-        return $uri;
-    }
+		return $uri;
+	}
 }

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;
+	}
 }