brightnucleus / config

src/Loader/LoaderFactory.php

Indentation +86 added lines, -86 removed lines

@@ -25,97 +25,97 @@
 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',
-    ];
+	/**
+	 * Array of fully qualified class names of known loaders.
+	 *
+	 * @var array<string>
+	 *
+	 * @since 0.4.0
+	 */
+	protected static $loaders = [
+		'BrightNucleus\Config\Loader\PHPLoader',
+	];
 
-    /**
-     * 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;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
     public static function getLoader($loaderClass)
     {
         try {
-            if (! array_key_exists($loaderClass, static::$loaderInstances)) {
+            if ( ! array_key_exists($loaderClass, static::$loaderInstances)) {
                 static::$loaderInstances[$loaderClass] = new $loaderClass;
             }
 

src/ConfigTrait.php

Indentation +94 added lines, -94 removed lines

@@ -26,105 +26,105 @@
 trait ConfigTrait
 {
 
-    /**
-     * Reference to the Config object.
-     *
-     * @since 0.1.2
-     *
-     * @var ConfigInterface
-     */
-    protected $config;
+	/**
+	 * Reference to the Config object.
+	 *
+	 * @since 0.1.2
+	 *
+	 * @var ConfigInterface
+	 */
+	protected $config;
 
-    /**
-     * Process the passed-in configuration file.
-     *
-     * @since 0.1.2
-     *
-     * @param ConfigInterface $config The Config to process.
-     * @param                 string  ... List of keys.
-     *
-     * @throws 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;
-    }
+	/**
+	 * 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();
-        Assert\that($keys)->all()->string()->notEmpty();
+	/**
+	 * Check whether the Config has a specific key.
+	 *
+	 * To get a value several levels deep, add the keys for each level as a comma-separated list.
+	 *
+	 * @since 0.1.2
+	 * @since 0.1.5 Accepts list of keys.
+	 *
+	 * @param string|array $_ List of keys.
+	 *
+	 * @return bool Whether the key is known.
+	 */
+	protected function hasConfigKey($_)
+	{
+		$keys = func_get_args();
+		Assert\that($keys)->all()->string()->notEmpty();
 
-        return $this->config->hasKey($keys);
-    }
+		return $this->config->hasKey($keys);
+	}
 
-    /**
-     * Get the Config value for a specific key.
-     *
-     * To get a value several levels deep, add the keys for each level as a comma-separated list.
-     *
-     * @since 0.1.2
-     * @since 0.1.5 Accepts list of keys.
-     *
-     * @param string|array $_ List of keys.
-     *
-     * @return mixed Value of the key.
-     */
-    protected function getConfigKey($_)
-    {
-        $keys = func_get_args();
-        Assert\that($keys)->all()->string()->notEmpty();
+	/**
+	 * Get the Config value for a specific key.
+	 *
+	 * To get a value several levels deep, add the keys for each level as a comma-separated list.
+	 *
+	 * @since 0.1.2
+	 * @since 0.1.5 Accepts list of keys.
+	 *
+	 * @param string|array $_ List of keys.
+	 *
+	 * @return mixed Value of the key.
+	 */
+	protected function getConfigKey($_)
+	{
+		$keys = func_get_args();
+		Assert\that($keys)->all()->string()->notEmpty();
 
-        return $this->config->getKey($keys);
-    }
+		return $this->config->getKey($keys);
+	}
 
-    /**
-     * Get a (multi-dimensional) array of all the configuration settings.
-     *
-     * @since 0.1.4
-     *
-     * @return array All the configuration settings.
-     */
-    protected function getConfigArray()
-    {
-        return $this->config->getAll();
-    }
+	/**
+	 * Get a (multi-dimensional) array of all the configuration settings.
+	 *
+	 * @since 0.1.4
+	 *
+	 * @return array All the configuration settings.
+	 */
+	protected function getConfigArray()
+	{
+		return $this->config->getAll();
+	}
 
-    /**
-     * Get an array of all the keys that are known by the Config.
-     *
-     * @since 0.1.2
-     *
-     * @return array Array of strings containing all the keys.
-     */
-    protected function getConfigKeys()
-    {
-        return $this->config->getKeys();
-    }
+	/**
+	 * Get an array of all the keys that are known by the Config.
+	 *
+	 * @since 0.1.2
+	 *
+	 * @return array Array of strings containing all the keys.
+	 */
+	protected function getConfigKeys()
+	{
+		return $this->config->getKeys();
+	}
 }

src/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/Config.php

Indentation +185 added lines, -185 removed lines

@@ -33,189 +33,189 @@
 class Config extends AbstractConfig
 {
 
-    /**
-     * The schema of the Config file.
-     *
-     * @var Schema
-     */
-    protected $schema;
-
-    /**
-     * The Validator class that gets asked to do the validation of the config.
-     *
-     * @since 0.1.0
-     *
-     * @var Validator
-     */
-    protected $validator;
-
-    /**
-     * Instantiate the Config object.
-     *
-     * It accepts either an array with the configuration settings, or a
-     * filename pointing to a PHP file it can include.
-     *
-     * @since 0.1.0
-     * @since 0.1.6 Accepts a delimiter to parse configuration keys.
-     *
-     * @param array|string         $config    Array with settings or filename for the
-     *                                        settings file.
-     * @param Schema|null          $schema    Optional. Config that contains default
-     *                                        values that can get overwritten.
-     * @param Validator|null       $validator Optional. Validator class that does the
-     *                                        actual validation.
-     * @param string[]|string|null $delimiter A string or array of strings that are used as delimiters to parse
-     *                                        configuration keys. Defaults to "\", "/" & ".".
-     *
-     * @throws InvalidConfigurationSourceException If the config source is not a string or array.
-     * @throws FailedToInstantiateParentException  If the parent class could not be instantiated.
-     * @throws FailedToLoadConfigException         If loading of the config source failed.
-     * @throws FailedToResolveConfigException      If the config file could not be resolved.
-     * @throws InvalidConfigException              If the config file is not valid.
-     */
-    public function __construct(
-        $config,
-        Schema $schema = null,
-        Validator $validator = null,
-        $delimiter = null
-    ) {
-        $this->schema    = $schema;
-        $this->validator = $validator;
-
-        // Make sure $config is either a string or array.
-        if (! (is_string($config) || is_array($config))) {
-            throw new InvalidConfigurationSourceException(
-                sprintf(
-                    _('Invalid configuration source: %1$s'),
-                    print_r($config, true)
-                )
-            );
-        }
-
-        if (is_string($config)) {
-            $config = Loader::load($config);
-        }
-
-        // Run the $config through the OptionsResolver.
-        Assert\that($config)->isArray();
-        $config = $this->resolveOptions($config);
-
-        // Instantiate the parent class.
-        try {
-            parent::__construct($config, $delimiter);
-        } catch (Exception $exception) {
-            throw new FailedToInstantiateParentException(
-                sprintf(
-                    _('Could not instantiate the configuration through its parent. Reason: %1$s'),
-                    $exception->getMessage()
-                )
-            );
-        }
-
-        // Finally, validate the resulting config.
-        if (! $this->isValid()) {
-            throw new InvalidConfigException(
-                sprintf(
-                    _('ConfigInterface file is not valid: %1$s'),
-                    print_r($config, true)
-                )
-            );
-        }
-    }
-
-    /**
-     * Validate the Config file.
-     *
-     * @since  0.1.0
-     *
-     * @return boolean
-     */
-    public function isValid()
-    {
-        if ($this->validator) {
-            return $this->validator->isValid($this);
-        }
-
-        return true;
-    }
-
-    /**
-     * Process the passed-in defaults and merge them with the new values, while
-     * checking that all required options are set.
-     *
-     * @since 0.1.0
-     *
-     * @param array $config Configuration settings to resolve.
-     *
-     * @return array Resolved configuration settings.
-     * @throws FailedToResolveConfigException If there are errors while resolving the options.
-     */
-    protected function resolveOptions($config)
-    {
-        if (! $this->schema) {
-            return $config;
-        }
-
-        try {
-            $resolver = new OptionsResolver();
-            if ($this->configureOptions($resolver)) {
-                $config = $resolver->resolve($config);
-            }
-        } catch (Exception $exception) {
-            throw new FailedToResolveConfigException(
-                sprintf(
-                    _('Error while resolving config options: %1$s'),
-                    $exception->getMessage()
-                )
-            );
-        }
-
-        return $config;
-    }
-
-    /**
-     * Configure the possible and required options for the Config.
-     *
-     * This should return a bool to let the resolve_options() know whether the
-     * actual resolving needs to be done or not.
-     *
-     * @since 0.1.0
-     *
-     * @param OptionsResolver $resolver Reference to the OptionsResolver
-     *                                  instance.
-     *
-     * @return bool Whether to do the resolving.
-     * @throws FailedToResolveConfigException If there are errors while processing.
-     */
-    protected function configureOptions(OptionsResolver $resolver)
-    {
-        $defined  = $this->schema->getDefinedOptions();
-        $defaults = $this->schema->getDefaultOptions();
-        $required = $this->schema->getRequiredOptions();
-
-        if (! $defined && ! $defaults && ! $required) {
-            return false;
-        }
-
-        try {
-            if ($defined) {
-                $resolver->setDefined($defined);
-            }
-            if ($defaults) {
-                $resolver->setDefaults($defaults);
-            }
-            if ($required) {
-                $resolver->setRequired($required);
-            }
-        } catch (Exception $exception) {
-            throw new FailedToResolveConfigException(
-                sprintf(
-                    _('Error while processing config options: %1$s'),
-                    $exception->getMessage()
-                )
-            );
-        }
-
-        return true;
-    }
+	/**
+	 * The schema of the Config file.
+	 *
+	 * @var Schema
+	 */
+	protected $schema;
+
+	/**
+	 * The Validator class that gets asked to do the validation of the config.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var Validator
+	 */
+	protected $validator;
+
+	/**
+	 * Instantiate the Config object.
+	 *
+	 * It accepts either an array with the configuration settings, or a
+	 * filename pointing to a PHP file it can include.
+	 *
+	 * @since 0.1.0
+	 * @since 0.1.6 Accepts a delimiter to parse configuration keys.
+	 *
+	 * @param array|string         $config    Array with settings or filename for the
+	 *                                        settings file.
+	 * @param Schema|null          $schema    Optional. Config that contains default
+	 *                                        values that can get overwritten.
+	 * @param Validator|null       $validator Optional. Validator class that does the
+	 *                                        actual validation.
+	 * @param string[]|string|null $delimiter A string or array of strings that are used as delimiters to parse
+	 *                                        configuration keys. Defaults to "\", "/" & ".".
+	 *
+	 * @throws InvalidConfigurationSourceException If the config source is not a string or array.
+	 * @throws FailedToInstantiateParentException  If the parent class could not be instantiated.
+	 * @throws FailedToLoadConfigException         If loading of the config source failed.
+	 * @throws FailedToResolveConfigException      If the config file could not be resolved.
+	 * @throws InvalidConfigException              If the config file is not valid.
+	 */
+	public function __construct(
+		$config,
+		Schema $schema = null,
+		Validator $validator = null,
+		$delimiter = null
+	) {
+		$this->schema    = $schema;
+		$this->validator = $validator;
+
+		// Make sure $config is either a string or array.
+		if (! (is_string($config) || is_array($config))) {
+			throw new InvalidConfigurationSourceException(
+				sprintf(
+					_('Invalid configuration source: %1$s'),
+					print_r($config, true)
+				)
+			);
+		}
+
+		if (is_string($config)) {
+			$config = Loader::load($config);
+		}
+
+		// Run the $config through the OptionsResolver.
+		Assert\that($config)->isArray();
+		$config = $this->resolveOptions($config);
+
+		// Instantiate the parent class.
+		try {
+			parent::__construct($config, $delimiter);
+		} catch (Exception $exception) {
+			throw new FailedToInstantiateParentException(
+				sprintf(
+					_('Could not instantiate the configuration through its parent. Reason: %1$s'),
+					$exception->getMessage()
+				)
+			);
+		}
+
+		// Finally, validate the resulting config.
+		if (! $this->isValid()) {
+			throw new InvalidConfigException(
+				sprintf(
+					_('ConfigInterface file is not valid: %1$s'),
+					print_r($config, true)
+				)
+			);
+		}
+	}
+
+	/**
+	 * Validate the Config file.
+	 *
+	 * @since  0.1.0
+	 *
+	 * @return boolean
+	 */
+	public function isValid()
+	{
+		if ($this->validator) {
+			return $this->validator->isValid($this);
+		}
+
+		return true;
+	}
+
+	/**
+	 * Process the passed-in defaults and merge them with the new values, while
+	 * checking that all required options are set.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param array $config Configuration settings to resolve.
+	 *
+	 * @return array Resolved configuration settings.
+	 * @throws FailedToResolveConfigException If there are errors while resolving the options.
+	 */
+	protected function resolveOptions($config)
+	{
+		if (! $this->schema) {
+			return $config;
+		}
+
+		try {
+			$resolver = new OptionsResolver();
+			if ($this->configureOptions($resolver)) {
+				$config = $resolver->resolve($config);
+			}
+		} catch (Exception $exception) {
+			throw new FailedToResolveConfigException(
+				sprintf(
+					_('Error while resolving config options: %1$s'),
+					$exception->getMessage()
+				)
+			);
+		}
+
+		return $config;
+	}
+
+	/**
+	 * Configure the possible and required options for the Config.
+	 *
+	 * This should return a bool to let the resolve_options() know whether the
+	 * actual resolving needs to be done or not.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param OptionsResolver $resolver Reference to the OptionsResolver
+	 *                                  instance.
+	 *
+	 * @return bool Whether to do the resolving.
+	 * @throws FailedToResolveConfigException If there are errors while processing.
+	 */
+	protected function configureOptions(OptionsResolver $resolver)
+	{
+		$defined  = $this->schema->getDefinedOptions();
+		$defaults = $this->schema->getDefaultOptions();
+		$required = $this->schema->getRequiredOptions();
+
+		if (! $defined && ! $defaults && ! $required) {
+			return false;
+		}
+
+		try {
+			if ($defined) {
+				$resolver->setDefined($defined);
+			}
+			if ($defaults) {
+				$resolver->setDefaults($defaults);
+			}
+			if ($required) {
+				$resolver->setRequired($required);
+			}
+		} catch (Exception $exception) {
+			throw new FailedToResolveConfigException(
+				sprintf(
+					_('Error while processing config options: %1$s'),
+					$exception->getMessage()
+				)
+			);
+		}
+
+		return true;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -83,7 +83,7 @@ 
         $this->validator = $validator;
 
         // Make sure $config is either a string or array.
-        if (! (is_string($config) || is_array($config))) {
+        if ( ! (is_string($config) || is_array($config))) {
             throw new InvalidConfigurationSourceException(
                 sprintf(
                     _('Invalid configuration source: %1$s'),
@@ -113,7 +113,7 @@ 
         }
 
         // Finally, validate the resulting config.
-        if (! $this->isValid()) {
+        if ( ! $this->isValid()) {
             throw new InvalidConfigException(
                 sprintf(
                     _('ConfigInterface file is not valid: %1$s'),
@@ -152,7 +152,7 @@ 
      */
     protected function resolveOptions($config)
     {
-        if (! $this->schema) {
+        if ( ! $this->schema) {
             return $config;
         }
 
@@ -193,7 +193,7 @@ 
         $defaults = $this->schema->getDefaultOptions();
         $required = $this->schema->getRequiredOptions();
 
-        if (! $defined && ! $defaults && ! $required) {
+        if ( ! $defined && ! $defaults && ! $required) {
             return false;
         }