brightnucleus / config

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

src/ConfigFactory.php

Indentation +225 added lines, -225 removed lines

@@ -24,230 +24,230 @@
 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_string($file)) {
-                    continue;
-                }
+	/**
+	 * 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_string($file)) {
+					continue;
+				}
                 
-                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];
-    }
+				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/Config.php

Indentation +184 added lines, -184 removed lines

@@ -32,188 +32,188 @@
 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.
-        $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.
+		$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;
+	}
 }

src/ConfigInterface.php

Indentation +88 added lines, -88 removed lines

@@ -27,100 +27,100 @@
 interface ConfigInterface extends IteratorAggregate, ArrayAccess, Serializable, Countable
 {
 
-    /**
-     * Creates a copy of the ArrayObject.
-     *
-     * Returns a copy of the array. When the ArrayObject refers to an object an
-     * array of the public properties of that object will be returned.
-     * This is implemented by \ArrayObject.
-     *
-     * @since 0.1.0
-     *
-     * @return array Copy of the array.
-     */
-    public function getArrayCopy();
+	/**
+	 * Creates a copy of the ArrayObject.
+	 *
+	 * Returns a copy of the array. When the ArrayObject refers to an object an
+	 * array of the public properties of that object will be returned.
+	 * This is implemented by \ArrayObject.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return array Copy of the array.
+	 */
+	public function getArrayCopy();
 
-    /**
-     * Check whether the Config has a specific key.
-     *
-     * To check a value several levels deep, add the keys for each level as a comma-separated list.
-     *
-     * @since 0.1.0
-     * @since 0.1.4 Accepts list of keys.
-     *
-     * @param string $_ List of keys.
-     *
-     * @return bool
-     */
-    public function hasKey($_);
+	/**
+	 * Check whether the Config has a specific key.
+	 *
+	 * To check a value several levels deep, add the keys for each level as a comma-separated list.
+	 *
+	 * @since 0.1.0
+	 * @since 0.1.4 Accepts list of keys.
+	 *
+	 * @param string $_ List of keys.
+	 *
+	 * @return bool
+	 */
+	public function hasKey($_);
 
-    /**
-     * Get the value of a specific key.
-     *
-     * To get a value several levels deep, add the keys for each level as a comma-separated list.
-     *
-     * @since 0.1.0
-     * @since 0.1.4 Accepts list of keys.
-     *
-     * @param string $_ List of keys.
-     *
-     * @return mixed
-     */
-    public function getKey($_);
+	/**
+	 * Get the value of a specific key.
+	 *
+	 * To get a value several levels deep, add the keys for each level as a comma-separated list.
+	 *
+	 * @since 0.1.0
+	 * @since 0.1.4 Accepts list of keys.
+	 *
+	 * @param string $_ List of keys.
+	 *
+	 * @return mixed
+	 */
+	public function getKey($_);
 
-    /**
-     * Get a (multi-dimensional) array of all the configuration settings.
-     *
-     * @since 0.1.4
-     *
-     * @return array
-     */
-    public function getAll();
+	/**
+	 * Get a (multi-dimensional) array of all the configuration settings.
+	 *
+	 * @since 0.1.4
+	 *
+	 * @return array
+	 */
+	public function getAll();
 
-    /**
-     * Get the an array with all the keys
-     *
-     * @since 0.1.0
-     *
-     * @return mixed
-     */
-    public function getKeys();
+	/**
+	 * Get the an array with all the keys
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return mixed
+	 */
+	public function getKeys();
 
-    /**
-     * Is the Config valid?
-     *
-     * @since 0.1.0
-     *
-     * @return boolean
-     */
-    public function isValid();
+	/**
+	 * Is the Config valid?
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return boolean
+	 */
+	public function isValid();
 
-    /**
-     * Get a new config at a specific sub-level.
-     *
-     * @since 0.1.13
-     *
-     * @param string $_ List of keys.
-     *
-     * @return ConfigInterface
-     */
-    public function getSubConfig($_);
+	/**
+	 * Get a new config at a specific sub-level.
+	 *
+	 * @since 0.1.13
+	 *
+	 * @param string $_ List of keys.
+	 *
+	 * @return ConfigInterface
+	 */
+	public function getSubConfig($_);
 
-    /**
-     * Serialize the config.
-     *
-     * @since 0.1.13
-     *
-     * @return array
-     */
-    public function __serialize(): array;
+	/**
+	 * Serialize the config.
+	 *
+	 * @since 0.1.13
+	 *
+	 * @return array
+	 */
+	public function __serialize(): array;
 
-    /**
-     * Unserialize the config.
-     *
-     * @since 0.1.13
-     *
-     * @param array $data The data to unserialize.
-     */
-    public function __unserialize(array $data): void;
+	/**
+	 * Unserialize the config.
+	 *
+	 * @since 0.1.13
+	 *
+	 * @param array $data The data to unserialize.
+	 */
+	public function __unserialize(array $data): void;
 }