blob: f011db2365dc61cbf5afc2b99c9cb4191d076a3d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
<?php
/**
* Phergie
*
* PHP version 5
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.
* It is also available through the world-wide-web at this URL:
* http://phergie.org/license
*
* @category Phergie
* @package Phergie
* @author Phergie Development Team <team@phergie.org>
* @copyright 2008-2010 Phergie Development Team (http://phergie.org)
* @license http://phergie.org/license New BSD License
* @link http://pear.phergie.org/package/Phergie
*/
/**
* Reads from and writes to PHP configuration files and provides access to
* the settings they contain.
*
* @category Phergie
* @package Phergie
* @author Phergie Development Team <team@phergie.org>
* @license http://phergie.org/license New BSD License
* @link http://pear.phergie.org/package/Phergie
*/
class Phergie_Config implements ArrayAccess
{
/**
* Mapping of configuration file paths to an array of names of settings
* they contain
*
* @var array
*/
protected $files = array();
/**
* Mapping of setting names to their current corresponding values
*
* @var array
*/
protected $settings = array();
/**
* Includes a specified PHP configuration file and incorporates its
* return value (which should be an associative array) into the current
* configuration settings.
*
* @param string $file Path to the file to read
*
* @return Phergie_Config Provides a fluent interface
* @throws Phergie_Config_Exception
*/
public function read($file)
{
if (!(strtoupper(substr(PHP_OS, 0, 3)) === 'WIN'
&& file_exists($file))
&& !is_executable($file)
) {
throw new Phergie_Config_Exception(
'Path "' . $file . '" does not reference an executable file',
Phergie_Config_Exception::ERR_FILE_NOT_EXECUTABLE
);
}
$settings = include $file;
if (!is_array($settings)) {
throw new Phergie_Config_Exception(
'File "' . $file . '" does not return an array',
Phergie_Config_Exception::ERR_ARRAY_NOT_RETURNED
);
}
$this->files[$file] = array_keys($settings);
$this->settings += $settings;
return $this;
}
/**
* Writes the values of the current configuration settings back to their
* originating files.
*
* @return Phergie_Config Provides a fluent interface
*/
public function write()
{
foreach ($this->files as $file => &$settings) {
$values = array();
foreach ($settings as $setting) {
$values[$setting] = $this->settings[$setting];
}
$source = '<?php' . PHP_EOL . PHP_EOL .
'return ' . var_export($value, true) . ';';
file_put_contents($file, $source);
}
}
/**
* Checks to see if a configuration setting is assigned a value.
*
* @param string $offset Configuration setting name
*
* @return bool TRUE if the setting has a value, FALSE otherwise
* @see ArrayAccess::offsetExists()
*/
public function offsetExists($offset)
{
return isset($this->settings[$offset]);
}
/**
* Returns the value of a configuration setting.
*
* @param string $offset Configuration setting name
*
* @return mixed Configuration setting value or NULL if it is not
* assigned a value
* @see ArrayAccess::offsetGet()
*/
public function offsetGet($offset)
{
if (isset($this->settings[$offset])) {
$value = &$this->settings[$offset];
} else {
$value = null;
}
return $value;
}
/**
* Sets the value of a configuration setting.
*
* @param string $offset Configuration setting name
* @param mixed $value New setting value
*
* @return void
* @see ArrayAccess::offsetSet()
*/
public function offsetSet($offset, $value)
{
$this->settings[$offset] = $value;
}
/**
* Removes the value set for a configuration setting.
*
* @param string $offset Configuration setting name
*
* @return void
* @see ArrayAccess::offsetUnset()
*/
public function offsetUnset($offset)
{
unset($this->settings[$offset]);
foreach ($this->files as $file => $settings) {
$key = array_search($offset, $settings);
if ($key !== false) {
unset($this->files[$file][$key]);
}
}
}
}
|
