brightnucleus / config

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

src/Loader/JSONLoader.php

Indentation +65 added lines, -65 removed lines

@@ -25,74 +25,74 @@
 class JSONLoader extends AbstractLoader
 {
 
-    /**
-     * Check whether the loader is able to load a given URI.
-     *
-     * @since 0.4.0
-     *
-     * @param string $uri URI to check.
-     *
-     * @return bool Whether the loader can load the given URI.
-     */
-    public static function canLoad($uri)
-    {
-        $path = pathinfo($uri);
+	/**
+	 * Check whether the loader is able to load a given URI.
+	 *
+	 * @since 0.4.0
+	 *
+	 * @param string $uri URI to check.
+	 *
+	 * @return bool Whether the loader can load the given URI.
+	 */
+	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 {
-            ob_start();
-            $data = json_decode(file_get_contents($uri), true);
-            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 {
+			ob_start();
+			$data = json_decode(file_get_contents($uri), true);
+			ob_end_clean();
 
-            return (array)$data;
-        } catch (Exception $exception) {
-            throw new FailedToLoadConfigException(
-                sprintf(
-                    _('Could not include JSON 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 JSON 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 JSON 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 JSON config file "%1$s" does not exist or is not readable.'),
+					$uri
+				)
+			);
+		}
 
-        return $uri;
-    }
+		return $uri;
+	}
 }

src/Loader/LoaderInterface.php

Indentation +21 added lines, -21 removed lines

@@ -22,26 +22,26 @@
 interface LoaderInterface
 {
 
-    /**
-     * Check whether the loader is able to load a given URI.
-     *
-     * @since 0.4.0
-     *
-     * @param string $uri URI to check.
-     *
-     * @return bool Whether the loader can load the given URI.
-     */
-    public static function canLoad($uri);
+	/**
+	 * Check whether the loader is able to load a given URI.
+	 *
+	 * @since 0.4.0
+	 *
+	 * @param string $uri URI to check.
+	 *
+	 * @return bool Whether the loader can load the given URI.
+	 */
+	public static function canLoad($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);
+	/**
+	 * 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);
 }

src/Loader/PHPLoader.php

Indentation +67 added lines, -67 removed lines

@@ -25,76 +25,76 @@
 class PHPLoader extends AbstractLoader
 {
 
-    /**
-     * Check whether the loader is able to load a given URI.
-     *
-     * @since 0.4.0
-     *
-     * @param string $uri URI to check.
-     *
-     * @return bool Whether the loader can load the given URI.
-     */
-    public static function canLoad($uri)
-    {
-        $path = pathinfo($uri);
+	/**
+	 * Check whether the loader is able to load a given URI.
+	 *
+	 * @since 0.4.0
+	 *
+	 * @param string $uri URI to check.
+	 *
+	 * @return bool Whether the loader can load the given URI.
+	 */
+	public static function canLoad($uri)
+	{
+		$path = pathinfo($uri);
 
-        return 'php' === mb_strtolower($path['extension']);
-    }
+		return 'php' === 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 = include($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 = include($uri);
+			ob_end_clean();
 
-            return $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 $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;
+	}
 }