|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* Veto. |
|
4
|
|
|
* PHP Microframework. |
|
5
|
|
|
* |
|
6
|
|
|
* @author Damien Walsh <[email protected]> |
|
7
|
|
|
* @copyright Damien Walsh 2013-2014 |
|
8
|
|
|
* @version 0.1 |
|
9
|
|
|
* @package veto |
|
10
|
|
|
*/ |
|
11
|
|
|
namespace Veto\Configuration; |
|
12
|
|
|
|
|
13
|
|
|
use Symfony\Component\Yaml\Parser; |
|
14
|
|
|
use Veto\Configuration\Exception\ConfigurationException; |
|
15
|
|
|
|
|
16
|
|
|
/** |
|
17
|
|
|
* Hive |
|
18
|
|
|
* Implements a configuration hive that can handle loading from YAML config files. |
|
19
|
|
|
* |
|
20
|
|
|
* @since 0.1 |
|
21
|
|
|
*/ |
|
22
|
|
|
class Hive implements \ArrayAccess |
|
23
|
|
|
{ |
|
24
|
|
|
private $values = array(); |
|
25
|
|
|
|
|
26
|
|
|
/** |
|
27
|
|
|
* Load configuration data from a YAML file. |
|
28
|
|
|
* |
|
29
|
|
|
* @todo Decouple this from the filesystem - make it accept a YAML string or stream instead |
|
30
|
|
|
* @throws ConfigurationException |
|
31
|
|
|
* @param string $path The path to the YAML configuration file. |
|
32
|
|
|
*/ |
|
33
|
|
|
public function load($path) |
|
34
|
|
|
{ |
|
35
|
|
|
$parser = new Parser(); |
|
36
|
|
|
$configYAML = file_get_contents($path); |
|
37
|
|
|
$config = $parser->parse($configYAML); |
|
38
|
|
|
|
|
39
|
|
|
// Process any config import directives |
|
40
|
|
|
$config = $this->processImports($path, $config); |
|
|
|
|
|
|
41
|
|
|
|
|
42
|
|
|
// Merge the configuration hive with this file |
|
43
|
|
|
$this->merge($config); |
|
44
|
|
|
} |
|
45
|
|
|
|
|
46
|
|
|
|
|
47
|
|
|
/** |
|
48
|
|
|
* Merge an array of data into this tree object. |
|
49
|
|
|
* The behaviour is identical to that of array_merge_recursive. |
|
50
|
|
|
* |
|
51
|
|
|
* @param array $data The data to merge into the tree. |
|
52
|
|
|
* @return bool |
|
53
|
|
|
*/ |
|
54
|
|
|
public function merge($data) |
|
55
|
|
|
{ |
|
56
|
|
|
$this->values = array_replace_recursive( |
|
57
|
|
|
$this->values, |
|
58
|
|
|
$data |
|
59
|
|
|
); |
|
60
|
|
|
|
|
61
|
|
|
return true; |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
|
|
/** |
|
65
|
|
|
* Retrieve the full configuration hive as an array. |
|
66
|
|
|
* |
|
67
|
|
|
* @return array |
|
68
|
|
|
*/ |
|
69
|
|
|
public function all() |
|
70
|
|
|
{ |
|
71
|
|
|
return $this->values; |
|
72
|
|
|
} |
|
73
|
|
|
|
|
74
|
|
|
/** |
|
75
|
|
|
* Whether a offset exists |
|
76
|
|
|
* |
|
77
|
|
|
* @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
78
|
|
|
* @param mixed $offset |
|
79
|
|
|
* @return boolean true on success or false on failure. |
|
80
|
|
|
*/ |
|
81
|
|
|
public function offsetExists($offset) |
|
82
|
|
|
{ |
|
83
|
|
|
return array_key_exists($offset, $this->values); |
|
84
|
|
|
} |
|
85
|
|
|
|
|
86
|
|
|
/** |
|
87
|
|
|
* Offset to retrieve |
|
88
|
|
|
* |
|
89
|
|
|
* @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
90
|
|
|
* @param mixed $offset |
|
91
|
|
|
* @return mixed Can return all value types. |
|
92
|
|
|
*/ |
|
93
|
|
|
public function offsetGet($offset) |
|
94
|
|
|
{ |
|
95
|
|
|
return $this->values[$offset]; |
|
96
|
|
|
} |
|
97
|
|
|
|
|
98
|
|
|
/** |
|
99
|
|
|
* Offset to set |
|
100
|
|
|
* |
|
101
|
|
|
* @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
102
|
|
|
* @param mixed $offset |
|
103
|
|
|
* @param mixed $value |
|
104
|
|
|
* @return void |
|
105
|
|
|
*/ |
|
106
|
|
|
public function offsetSet($offset, $value) |
|
107
|
|
|
{ |
|
108
|
|
|
$this->values[$offset] = $value; |
|
109
|
|
|
} |
|
110
|
|
|
|
|
111
|
|
|
/** |
|
112
|
|
|
* Offset to unset |
|
113
|
|
|
* |
|
114
|
|
|
* @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
115
|
|
|
* @param mixed $offset |
|
116
|
|
|
* @return void |
|
117
|
|
|
*/ |
|
118
|
|
|
public function offsetUnset($offset) |
|
119
|
|
|
{ |
|
120
|
|
|
unset($this->values[$offset]); |
|
121
|
|
|
} |
|
122
|
|
|
|
|
123
|
|
|
/** |
|
124
|
|
|
* Process any @import directives that occur at the top-level of the configuration array. |
|
125
|
|
|
* |
|
126
|
|
|
* @param string $basePath The base path used for relative @import directives |
|
127
|
|
|
* @param array $config The configuration array being processed |
|
128
|
|
|
* @return array |
|
129
|
|
|
* @throws ConfigurationException |
|
130
|
|
|
*/ |
|
131
|
|
|
private function processImports($basePath, array $config) |
|
132
|
|
|
{ |
|
133
|
|
|
// Process any @import directives |
|
134
|
|
|
if (array_key_exists('@import', $config)) { |
|
135
|
|
|
|
|
136
|
|
|
if (!is_array($config['@import'])) { |
|
137
|
|
|
throw new ConfigurationException( |
|
138
|
|
|
'@import directives must contain an array of configuration file paths.' |
|
139
|
|
|
); |
|
140
|
|
|
} |
|
141
|
|
|
|
|
142
|
|
|
foreach($config['@import'] as $importPath) { |
|
143
|
|
|
$importPath = dirname($basePath) . '/' . $importPath; |
|
144
|
|
|
|
|
145
|
|
|
if (!file_exists($importPath)) { |
|
146
|
|
|
throw ConfigurationException::missingImportedFile( |
|
147
|
|
|
$importPath, |
|
148
|
|
|
$basePath |
|
149
|
|
|
); |
|
150
|
|
|
} |
|
151
|
|
|
|
|
152
|
|
|
$this->load($importPath); |
|
153
|
|
|
} |
|
154
|
|
|
|
|
155
|
|
|
// Do not keep these in the configuration hive |
|
156
|
|
|
unset($config['@import']); |
|
157
|
|
|
} |
|
158
|
|
|
|
|
159
|
|
|
return $config; |
|
160
|
|
|
} |
|
161
|
|
|
} |
themainframe /
veto
If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:
If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.