brightnucleus / config

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