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 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. |
|
|
|
|
47
|
|
|
*/ |
48
|
2 |
|
public static function createFromFile($_) |
|
|
|
|
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 |
|
while (count($files) > 0) { |
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
|
2 |
|
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. |
|
|
|
|
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. |
|
|
|
|
113
|
|
|
*/ |
114
|
4 |
|
public static function create($_) |
|
|
|
|
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
|
|
|
* Get a config file from the config file cache. |
131
|
|
|
* |
132
|
|
|
* @since 0.4.4 |
133
|
|
|
* |
134
|
|
|
* @param string $identifier Identifier to look for in the cache. |
135
|
|
|
* @param mixed $fallback Fallback to use to fill the cache. If $fallback is a callable, it will be executed |
136
|
|
|
* with $identifier as an argument. |
137
|
|
|
* |
138
|
|
|
* @return mixed The latest content of the cache for the given identifier. |
139
|
|
|
*/ |
140
|
1 |
|
protected static function getFromCache($identifier, $fallback) |
141
|
|
|
{ |
142
|
1 |
|
if (! array_key_exists($identifier, static::$configFilesCache)) { |
143
|
1 |
|
static::$configFilesCache[$identifier] = is_callable($fallback) |
144
|
1 |
|
? $fallback($identifier) |
145
|
|
|
: $fallback; |
146
|
|
|
} |
147
|
|
|
|
148
|
1 |
|
return static::$configFilesCache[$identifier]; |
149
|
|
|
} |
150
|
|
|
} |
151
|
|
|
|
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.