@@ -24,154 +24,154 @@ |
||
24 | 24 | class ConfigFactory |
25 | 25 | { |
26 | 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. |
|
47 | - */ |
|
48 | - public static function createFromFile($_) |
|
49 | - { |
|
50 | - $files = array_reverse(func_get_args()); |
|
51 | - |
|
52 | - if (is_array($files[0])) { |
|
53 | - $files = $files[0]; |
|
54 | - } |
|
55 | - |
|
56 | - while (count($files) > 0) { |
|
57 | - try { |
|
58 | - $file = array_pop($files); |
|
59 | - |
|
60 | - if (! is_readable($file)) { |
|
61 | - continue; |
|
62 | - } |
|
63 | - |
|
64 | - $config = static::createFromArray( |
|
65 | - static::getFromCache($file, function ($file) { |
|
66 | - return Loader::load($file); |
|
67 | - }) |
|
68 | - ); |
|
69 | - |
|
70 | - if (null === $config) { |
|
71 | - continue; |
|
72 | - } |
|
73 | - |
|
74 | - 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. |
|
91 | - */ |
|
92 | - public static function createFromArray(array $array) |
|
93 | - { |
|
94 | - try { |
|
95 | - 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. |
|
113 | - */ |
|
114 | - public static function create($_) |
|
115 | - { |
|
116 | - if (func_num_args() < 1) { |
|
117 | - return static::createFromArray([]); |
|
118 | - } |
|
119 | - |
|
120 | - $arguments = func_get_args(); |
|
121 | - |
|
122 | - if (is_array($arguments[0]) && func_num_args() === 1) { |
|
123 | - return static::createFromArray($arguments[0]); |
|
124 | - } |
|
125 | - |
|
126 | - return static::createFromFile($arguments); |
|
127 | - } |
|
128 | - |
|
129 | - /** |
|
130 | - * Create a new ConfigInterface object from a file and return a sub-portion of it. |
|
131 | - * |
|
132 | - * The first argument needs to be the file name to load, and the subsequent arguments will be passed on to |
|
133 | - * `Config::getSubConfig()`. |
|
134 | - * |
|
135 | - * @since 0.4.5 |
|
136 | - * |
|
137 | - * @param mixed $_ File name of the config to load as a string, followed by an array of keys to pass to |
|
138 | - * `Config::getSubConfig()`. |
|
139 | - * |
|
140 | - * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
141 | - */ |
|
142 | - public static function createSubConfig($_) |
|
143 | - { |
|
144 | - if (func_num_args() < 2) { |
|
145 | - return static::createFromArray([]); |
|
146 | - } |
|
147 | - |
|
148 | - $arguments = func_get_args(); |
|
149 | - $file = array_shift($arguments); |
|
150 | - |
|
151 | - $config = static::createFromFile($file); |
|
152 | - |
|
153 | - return $config->getSubConfig($arguments); |
|
154 | - } |
|
155 | - |
|
156 | - /** |
|
157 | - * Get a config file from the config file cache. |
|
158 | - * |
|
159 | - * @since 0.4.4 |
|
160 | - * |
|
161 | - * @param string $identifier Identifier to look for in the cache. |
|
162 | - * @param mixed $fallback Fallback to use to fill the cache. If $fallback is a callable, it will be executed |
|
163 | - * with $identifier as an argument. |
|
164 | - * |
|
165 | - * @return mixed The latest content of the cache for the given identifier. |
|
166 | - */ |
|
167 | - protected static function getFromCache($identifier, $fallback) |
|
168 | - { |
|
169 | - if (! array_key_exists($identifier, static::$configFilesCache)) { |
|
170 | - static::$configFilesCache[$identifier] = is_callable($fallback) |
|
171 | - ? $fallback($identifier) |
|
172 | - : $fallback; |
|
173 | - } |
|
174 | - |
|
175 | - return static::$configFilesCache[$identifier]; |
|
176 | - } |
|
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. |
|
47 | + */ |
|
48 | + public static function createFromFile($_) |
|
49 | + { |
|
50 | + $files = array_reverse(func_get_args()); |
|
51 | + |
|
52 | + if (is_array($files[0])) { |
|
53 | + $files = $files[0]; |
|
54 | + } |
|
55 | + |
|
56 | + while (count($files) > 0) { |
|
57 | + try { |
|
58 | + $file = array_pop($files); |
|
59 | + |
|
60 | + if (! is_readable($file)) { |
|
61 | + continue; |
|
62 | + } |
|
63 | + |
|
64 | + $config = static::createFromArray( |
|
65 | + static::getFromCache($file, function ($file) { |
|
66 | + return Loader::load($file); |
|
67 | + }) |
|
68 | + ); |
|
69 | + |
|
70 | + if (null === $config) { |
|
71 | + continue; |
|
72 | + } |
|
73 | + |
|
74 | + 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. |
|
91 | + */ |
|
92 | + public static function createFromArray(array $array) |
|
93 | + { |
|
94 | + try { |
|
95 | + 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. |
|
113 | + */ |
|
114 | + public static function create($_) |
|
115 | + { |
|
116 | + if (func_num_args() < 1) { |
|
117 | + return static::createFromArray([]); |
|
118 | + } |
|
119 | + |
|
120 | + $arguments = func_get_args(); |
|
121 | + |
|
122 | + if (is_array($arguments[0]) && func_num_args() === 1) { |
|
123 | + return static::createFromArray($arguments[0]); |
|
124 | + } |
|
125 | + |
|
126 | + return static::createFromFile($arguments); |
|
127 | + } |
|
128 | + |
|
129 | + /** |
|
130 | + * Create a new ConfigInterface object from a file and return a sub-portion of it. |
|
131 | + * |
|
132 | + * The first argument needs to be the file name to load, and the subsequent arguments will be passed on to |
|
133 | + * `Config::getSubConfig()`. |
|
134 | + * |
|
135 | + * @since 0.4.5 |
|
136 | + * |
|
137 | + * @param mixed $_ File name of the config to load as a string, followed by an array of keys to pass to |
|
138 | + * `Config::getSubConfig()`. |
|
139 | + * |
|
140 | + * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
141 | + */ |
|
142 | + public static function createSubConfig($_) |
|
143 | + { |
|
144 | + if (func_num_args() < 2) { |
|
145 | + return static::createFromArray([]); |
|
146 | + } |
|
147 | + |
|
148 | + $arguments = func_get_args(); |
|
149 | + $file = array_shift($arguments); |
|
150 | + |
|
151 | + $config = static::createFromFile($file); |
|
152 | + |
|
153 | + return $config->getSubConfig($arguments); |
|
154 | + } |
|
155 | + |
|
156 | + /** |
|
157 | + * Get a config file from the config file cache. |
|
158 | + * |
|
159 | + * @since 0.4.4 |
|
160 | + * |
|
161 | + * @param string $identifier Identifier to look for in the cache. |
|
162 | + * @param mixed $fallback Fallback to use to fill the cache. If $fallback is a callable, it will be executed |
|
163 | + * with $identifier as an argument. |
|
164 | + * |
|
165 | + * @return mixed The latest content of the cache for the given identifier. |
|
166 | + */ |
|
167 | + protected static function getFromCache($identifier, $fallback) |
|
168 | + { |
|
169 | + if (! array_key_exists($identifier, static::$configFilesCache)) { |
|
170 | + static::$configFilesCache[$identifier] = is_callable($fallback) |
|
171 | + ? $fallback($identifier) |
|
172 | + : $fallback; |
|
173 | + } |
|
174 | + |
|
175 | + return static::$configFilesCache[$identifier]; |
|
176 | + } |
|
177 | 177 | } |