ConfigFactory::createFromArray() - Code Metrics - Inspection of "Update README.md" - brightnucleus/config - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ff50a5...68a6b1 )

by Alain

created 2017-12-17 14:28 UTC

ConfigFactory::createFromArray() A

↳ Parent: ConfigFactory

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2.5

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	2
cts	4
cp	0.5
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	1
crap	2.5

<?php
/**
 * Bright Nucleus Config Component.
 *
 * @package   BrightNucleus\Config
 * @author    Alain Schlesser <[email protected]>
 * @license   MIT
 * @link      http://www.brightnucleus.com/
 * @copyright 2016-2017 Alain Schlesser, Bright Nucleus
 */

namespace BrightNucleus\Config;

use Exception;

/**
 * Create new object instances that implement ConfigInterface.
 *
 * @since   0.3.0
 *
 * @package BrightNucleus\Config
 * @author  Alain Schlesser <[email protected]>
 */
class ConfigFactory
{

    /**
     * Cached contents of the config files.
     *
     * @since 0.4.3
     *
     * @var array
     */
    protected static $configFilesCache = [];

    /**
     * Create a new ConfigInterface object from a file.
     *
     * If a comma-separated list of files is provided, they are checked in sequence until the first one could be loaded
     * successfully.
     *
     * @since 0.3.0
     *
     * @param string|array $_ List of files.
     *
     * @return ConfigInterface Instance of a ConfigInterface implementation.

     */
    public static function createFromFile($_)

    {
        $files = array_reverse(func_get_args());

        if (is_array($files[0])) {
            $files = $files[0];
        }

        while (count($files) > 0) {

            try {
                $file = array_pop($files);

                if (! is_readable($file)) {
                    continue;
                }

                $config = static::createFromArray(
                    static::getFromCache($file, function ($file) {
                        return Loader::load($file);
                    })
                );

                if (null === $config) {
                    continue;
                }

                return $config;
            } catch (Exception $exception) {
                // Fail silently and try next file.
            }
        }

        return static::createFromArray([]);
    }

    /**
     * Create a new ConfigInterface object from an array.
     *
     * @since 0.3.0
     *
     * @param array $array Array with configuration values.
     *
     * @return ConfigInterface Instance of a ConfigInterface implementation.

     */
    public static function createFromArray(array $array)
    {
        try {
            return new Config($array);
        } catch (Exception $exception) {
            // Fail silently and try next file.
        }

        return null;
    }

    /**
     * Create a new ConfigInterface object.
     *
     * Tries to deduce the correct creation method by inspecting the provided arguments.
     *
     * @since 0.3.0
     *
     * @param mixed $_ Array with configuration values.
     *
     * @return ConfigInterface Instance of a ConfigInterface implementation.

     */
    public static function create($_)

    {
        if (func_num_args() < 1) {
            return static::createFromArray([]);
        }

        $arguments = func_get_args();

        if (is_array($arguments[0]) && func_num_args() === 1) {
            return static::createFromArray($arguments[0]);
        }

        return static::createFromFile($arguments);
    }

    /**
     * Create a new ConfigInterface object, by merging several files together.
     *
     * Duplicate keys in later files will override those in earlier files.
     *
     * @since 0.4.6
     *
     * @param mixed $_ Array with configuration values.
     *
     * @return ConfigInterface Instance of a ConfigInterface implementation.

     */
    public static function merge($_)

    {
        if (func_num_args() < 1) {
            return static::createFromArray([]);
        }

        $arguments = func_get_args();

        if (is_array($arguments[0]) && func_num_args() === 1) {
            return static::createFromArray($arguments[0]);
        }

        return static::mergeFromFiles($arguments);
    }

    /**
     * Create a new ConfigInterface object by merging data from several files.
     *
     * If a comma-separated list of files is provided, they are loaded in sequence and later files override settings in
     * earlier files.
     *
     * @since 0.4.6
     *
     * @param string|array $_ List of files.
     *
     * @return ConfigInterface Instance of a ConfigInterface implementation.

     */
    public static function mergeFromFiles($_)

    {
        $files = array_reverse(func_get_args());
        $data  = [];

        if (is_array($files[0])) {
            $files = array_reverse($files[0]);
        }

        while (count($files) > 0) {

            try {
                $file = array_pop($files);

                if (! is_readable($file)) {
                    continue;
                }

                $new_data = static::getFromCache($file, function ($file) {
                    return Loader::load($file);
                });

                if (null === $data) {
                    continue;
                }

                $data = array_replace_recursive($data, $new_data);
            } catch (Exception $exception) {
                // Fail silently and try next file.
            }
        }

        return static::createFromArray($data);
    }

    /**
     * Create a new ConfigInterface object from a file and return a sub-portion of it.
     *
     * The first argument needs to be the file name to load, and the subsequent arguments will be passed on to
     * `Config::getSubConfig()`.
     *
     * @since 0.4.5
     *
     * @param mixed $_ File name of the config to load as a string, followed by an array of keys to pass to
     *                 `Config::getSubConfig()`.
     *
     * @return ConfigInterface Instance of a ConfigInterface implementation.
     */
    public static function createSubConfig($_)
    {
        if (func_num_args() < 2) {
            return static::createFromArray([]);
        }

        $arguments = func_get_args();
        $file      = array_shift($arguments);

        $config = static::createFromFile($file);

        return $config->getSubConfig($arguments);
    }

    /**
     * Get a config file from the config file cache.
     *
     * @since 0.4.4
     *
     * @param string $identifier Identifier to look for in the cache.
     * @param mixed  $fallback   Fallback to use to fill the cache. If $fallback is a callable, it will be executed
     *                           with $identifier as an argument.
     *
     * @return mixed The latest content of the cache for the given identifier.
     */
    protected static function getFromCache($identifier, $fallback)
    {
        if (! array_key_exists($identifier, static::$configFilesCache)) {
            static::$configFilesCache[$identifier] = is_callable($fallback)
                ? $fallback($identifier)
                : $fallback;
        }

        return static::$configFilesCache[$identifier];
    }
}


1			<?php
2			/**
3			* Bright Nucleus Config Component.
4			*
5			* @package BrightNucleus\Config
6			* @author Alain Schlesser <[email protected]>
7			* @license MIT
8			* @link http://www.brightnucleus.com/
9			* @copyright 2016-2017 Alain Schlesser, Bright Nucleus
10			*/
11
12			namespace BrightNucleus\Config;
13
14			use Exception;
15
16			/**
17			* Create new object instances that implement ConfigInterface.
18			*
19			* @since 0.3.0
20			*
21			* @package BrightNucleus\Config
22			* @author Alain Schlesser <[email protected]>
23			*/
24			class ConfigFactory
25			{
26
27			/**
28			* Cached contents of the config files.
29			*
30			* @since 0.4.3
31			*
32			* @var array
33			*/
34			protected static $configFilesCache = [];
35
36			/**
37			* Create a new ConfigInterface object from a file.
38			*
39			* If a comma-separated list of files is provided, they are checked in sequence until the first one could be loaded
40			* successfully.
41			*
42			* @since 0.3.0
43			*
44			* @param string\|array $_ List of files.
45			*
46			* @return ConfigInterface Instance of a ConfigInterface implementation.
			0 ignored issues – show Documentation introduced 2016-04-28 04:02 UTC by Report Bug Copy Issue Report Should the return type not be `Config\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
47			*/
48	2		public static function createFromFile($_)
			0 ignored issues – show Unused Code introduced 2016-04-28 04:02 UTC by Report Bug Copy Issue Report The parameter `$_` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
49			{
50	2		$files = array_reverse(func_get_args());
51
52	2		if (is_array($files[0])) {
53	1		$files = $files[0];
54			}
55
56	2	View Code Duplication	while (count($files) > 0) {
			0 ignored issues – show Duplication introduced 2016-07-22 10:37 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
57			try {
58	2		$file = array_pop($files);
59
60	2		if (! is_readable($file)) {
61	1		continue;
62			}
63
64	2		$config = static::createFromArray(
65			static::getFromCache($file, function ($file) {
66	1		return Loader::load($file);
67	2		})
68			);
69
70	2		if (null === $config) {
71			continue;
72			}
73
74	2		return $config;
75			} catch (Exception $exception) {
76			// Fail silently and try next file.
77			}
78			}
79
80			return static::createFromArray([]);
81			}
82
83			/**
84			* Create a new ConfigInterface object from an array.
85			*
86			* @since 0.3.0
87			*
88			* @param array $array Array with configuration values.
89			*
90			* @return ConfigInterface Instance of a ConfigInterface implementation.
			0 ignored issues – show Documentation introduced 2016-04-28 04:02 UTC by Report Bug Copy Issue Report Should the return type not be `Config\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
91			*/
92	2		public static function createFromArray(array $array)
93			{
94			try {
95	2		return new Config($array);
96			} catch (Exception $exception) {
97			// Fail silently and try next file.
98			}
99
100			return null;
101			}
102
103			/**
104			* Create a new ConfigInterface object.
105			*
106			* Tries to deduce the correct creation method by inspecting the provided arguments.
107			*
108			* @since 0.3.0
109			*
110			* @param mixed $_ Array with configuration values.
111			*
112			* @return ConfigInterface Instance of a ConfigInterface implementation.
			0 ignored issues – show Documentation introduced 2016-04-28 04:02 UTC by Report Bug Copy Issue Report Should the return type not be `Config\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
113			*/
114	4	View Code Duplication	public static function create($_)
			0 ignored issues – show Unused Code introduced 2016-04-04 17:46 UTC by Report Bug Copy Issue Report The parameter `$_` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2016-07-22 10:37 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
115			{
116	4		if (func_num_args() < 1) {
117			return static::createFromArray([]);
118			}
119
120	4		$arguments = func_get_args();
121
122	4		if (is_array($arguments[0]) && func_num_args() === 1) {
123	1		return static::createFromArray($arguments[0]);
124			}
125
126	3		return static::createFromFile($arguments);
127			}
128
129			/**
130			* Create a new ConfigInterface object, by merging several files together.
131			*
132			* Duplicate keys in later files will override those in earlier files.
133			*
134			* @since 0.4.6
135			*
136			* @param mixed $_ Array with configuration values.
137			*
138			* @return ConfigInterface Instance of a ConfigInterface implementation.
			0 ignored issues – show Documentation introduced 2016-07-22 10:37 UTC by Report Bug Copy Issue Report Should the return type not be `Config\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
139			*/
140	3	View Code Duplication	public static function merge($_)
			0 ignored issues – show Unused Code introduced 2016-07-22 10:37 UTC by Report Bug Copy Issue Report The parameter `$_` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2016-07-22 10:37 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
141			{
142	3		if (func_num_args() < 1) {
143			return static::createFromArray([]);
144			}
145
146	3		$arguments = func_get_args();
147
148	3		if (is_array($arguments[0]) && func_num_args() === 1) {
149			return static::createFromArray($arguments[0]);
150			}
151
152	3		return static::mergeFromFiles($arguments);
153			}
154
155			/**
156			* Create a new ConfigInterface object by merging data from several files.
157			*
158			* If a comma-separated list of files is provided, they are loaded in sequence and later files override settings in
159			* earlier files.
160			*
161			* @since 0.4.6
162			*
163			* @param string\|array $_ List of files.
164			*
165			* @return ConfigInterface Instance of a ConfigInterface implementation.
			0 ignored issues – show Documentation introduced 2016-07-22 10:37 UTC by Report Bug Copy Issue Report Should the return type not be `Config\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
166			*/
167			public static function mergeFromFiles($_)
			0 ignored issues – show Unused Code introduced 2016-07-22 10:37 UTC by Report Bug Copy Issue Report The parameter `$_` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
168			{
169			$files = array_reverse(func_get_args());
170			$data = [];
171
172			if (is_array($files[0])) {
173			$files = array_reverse($files[0]);
174			}
175
176		View Code Duplication	while (count($files) > 0) {
			0 ignored issues – show Duplication introduced 2016-07-22 10:37 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
177			try {
178			$file = array_pop($files);
179
180			if (! is_readable($file)) {
181			continue;
182			}
183
184			$new_data = static::getFromCache($file, function ($file) {
185			return Loader::load($file);
186			});
187
188			if (null === $data) {
189			continue;
190			}
191
192			$data = array_replace_recursive($data, $new_data);
193			} catch (Exception $exception) {
194			// Fail silently and try next file.
195			}
196			}
197
198			return static::createFromArray($data);
199			}
200
201			/**
202			* Create a new ConfigInterface object from a file and return a sub-portion of it.
203			*
204			* The first argument needs to be the file name to load, and the subsequent arguments will be passed on to
205			* `Config::getSubConfig()`.
206			*
207			* @since 0.4.5
208			*
209			* @param mixed $_ File name of the config to load as a string, followed by an array of keys to pass to
210			* `Config::getSubConfig()`.
211			*
212			* @return ConfigInterface Instance of a ConfigInterface implementation.
213			*/
214	1		public static function createSubConfig($_)
215			{
216	1		if (func_num_args() < 2) {
217			return static::createFromArray([]);
218			}
219
220	1		$arguments = func_get_args();
221	1		$file = array_shift($arguments);
222
223	1		$config = static::createFromFile($file);
224
225	1		return $config->getSubConfig($arguments);
226			}
227
228			/**
229			* Get a config file from the config file cache.
230			*
231			* @since 0.4.4
232			*
233			* @param string $identifier Identifier to look for in the cache.
234			* @param mixed $fallback Fallback to use to fill the cache. If $fallback is a callable, it will be executed
235			* with $identifier as an argument.
236			*
237			* @return mixed The latest content of the cache for the given identifier.
238			*/
239	1		protected static function getFromCache($identifier, $fallback)
240			{
241	1		if (! array_key_exists($identifier, static::$configFilesCache)) {
242	1		static::$configFilesCache[$identifier] = is_callable($fallback)
243	1		? $fallback($identifier)
244			: $fallback;
245			}
246
247	1		return static::$configFilesCache[$identifier];
248			}
249			}
250

brightnucleus / config

Push — master ( ff50a5...68a6b1 )

ConfigFactory::createFromArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like