-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
Configure.php
407 lines (382 loc) · 12.1 KB
/
Configure.php
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package Cake.Core
* @since CakePHP(tm) v 1.0.0.2363
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
namespace Cake\Core;
use Cake\Cache\Cache;
use Cake\Configure\ConfigReaderInterface;
use Cake\Configure\PhpReader;
use Cake\Error;
use Cake\Utility\Hash;
/**
* Configuration class. Used for managing runtime configuration information.
*
* Provides features for reading and writing to the runtime configuration, as well
* as methods for loading additional configuration files or storing runtime configuration
* for future use.
*
* @package Cake.Core
* @link http://book.cakephp.org/2.0/en/development/configuration.html#configure-class
*/
class Configure {
/**
* Array of values currently stored in Configure.
*
* @var array
*/
protected static $_values = array(
'debug' => 0
);
/**
* Configured reader classes, used to load config files from resources
*
* @var array
* @see Configure::load()
*/
protected static $_readers = array();
/**
* Initializes configure and runs the bootstrap process.
* Bootstrapping includes the following steps:
*
* - Setup App array in Configure.
* - Include app/Config/core.php.
* - Configure core cache configurations.
* - Load App cache files.
* - Include app/Config/bootstrap.php.
* - Setup error/exception handlers.
*
* @param boolean $boot
* @return void
*/
public static function bootstrap($boot = true) {
if ($boot) {
static::write('App', array(
'base' => false,
'baseUrl' => false,
'dir' => APP_DIR,
'webroot' => WEBROOT_DIR,
'www_root' => WWW_ROOT
));
App::init();
App::build();
}
}
/**
* Used to store a dynamic variable in Configure.
*
* Usage:
* {{{
* Configure::write('One.key1', 'value of the Configure::One[key1]');
* Configure::write(array('One.key1' => 'value of the Configure::One[key1]'));
* Configure::write('One', array(
* 'key1' => 'value of the Configure::One[key1]',
* 'key2' => 'value of the Configure::One[key2]'
* );
*
* Configure::write(array(
* 'One.key1' => 'value of the Configure::One[key1]',
* 'One.key2' => 'value of the Configure::One[key2]'
* ));
* }}}
*
* @link http://book.cakephp.org/2.0/en/development/configuration.html#Configure::write
* @param array $config Name of var to write
* @param mixed $value Value to set for var
* @return boolean True if write was successful
*/
public static function write($config, $value = null) {
if (!is_array($config)) {
$config = array($config => $value);
}
foreach ($config as $name => $value) {
static::$_values = Hash::insert(static::$_values, $name, $value);
}
if (isset($config['debug']) && function_exists('ini_set')) {
if (static::$_values['debug']) {
ini_set('display_errors', 1);
} else {
ini_set('display_errors', 0);
}
}
return true;
}
/**
* Used to read information stored in Configure. Its not
* possible to store `null` values in Configure.
*
* Usage:
* {{{
* Configure::read('Name'); will return all values for Name
* Configure::read('Name.key'); will return only the value of Configure::Name[key]
* }}}
*
* @linkhttp://book.cakephp.org/2.0/en/development/configuration.html#Configure::read
* @param string $var Variable to obtain. Use '.' to access array elements.
* @return mixed value stored in configure, or null.
*/
public static function read($var = null) {
if ($var === null) {
return static::$_values;
}
return Hash::get(static::$_values, $var);
}
/**
* Returns true if given variable is set in Configure.
*
* @param string $var Variable name to check for
* @return boolean True if variable is there
*/
public static function check($var = null) {
if (empty($var)) {
return false;
}
return Hash::get(self::$_values, $var) !== null;
}
/**
* Used to delete a variable from Configure.
*
* Usage:
* {{{
* Configure::delete('Name'); will delete the entire Configure::Name
* Configure::delete('Name.key'); will delete only the Configure::Name[key]
* }}}
*
* @link http://book.cakephp.org/2.0/en/development/configuration.html#Configure::delete
* @param string $var the var to be deleted
* @return void
*/
public static function delete($var = null) {
$keys = explode('.', $var);
$last = array_pop($keys);
static::$_values = Hash::remove(static::$_values, $var);
}
/**
* Add a new reader to Configure. Readers allow you to read configuration
* files in various formats/storage locations. CakePHP comes with two built-in readers
* PhpReader and IniReader. You can also implement your own reader classes in your application.
*
* To add a new reader to Configure:
*
* `Configure::config('ini', new IniReader());`
*
* @param string $name The name of the reader being configured. This alias is used later to
* read values from a specific reader.
* @param ConfigReaderInterface $reader The reader to append.
* @return void
*/
public static function config($name, ConfigReaderInterface $reader) {
static::$_readers[$name] = $reader;
}
/**
* Gets the names of the configured reader objects.
*
* @param string $name
* @return array Array of the configured reader objects.
*/
public static function configured($name = null) {
if ($name) {
return isset(static::$_readers[$name]);
}
return array_keys(static::$_readers);
}
/**
* Remove a configured reader. This will unset the reader
* and make any future attempts to use it cause an Exception.
*
* @param string $name Name of the reader to drop.
* @return boolean Success
*/
public static function drop($name) {
if (!isset(static::$_readers[$name])) {
return false;
}
unset(static::$_readers[$name]);
return true;
}
/**
* Loads stored configuration information from a resource. You can add
* config file resource readers with `Configure::config()`.
*
* Loaded configuration information will be merged with the current
* runtime configuration. You can load configuration files from plugins
* by preceding the filename with the plugin name.
*
* `Configure::load('Users.user', 'default')`
*
* Would load the 'user' config file using the default config reader. You can load
* app config files by giving the name of the resource you want loaded.
*
* `Configure::load('setup', 'default');`
*
* If using `default` config and no reader has been configured for it yet,
* one will be automatically created using PhpReader
*
* @link http://book.cakephp.org/2.0/en/development/configuration.html#Configure::load
* @param string $key name of configuration resource to load.
* @param string $config Name of the configured reader to use to read the resource identified by $key.
* @param boolean $merge if config files should be merged instead of simply overridden
* @return mixed false if file not found, void if load successful.
* @throws Cake\Error\ConfigureException Will throw any exceptions the reader raises.
*/
public static function load($key, $config = 'default', $merge = true) {
$reader = static::_getReader($config);
if (!$reader) {
return false;
}
$values = $reader->read($key);
if ($merge) {
$keys = array_keys($values);
foreach ($keys as $key) {
if (($c = static::read($key)) && is_array($values[$key]) && is_array($c)) {
$values[$key] = Hash::merge($c, $values[$key]);
}
}
}
return static::write($values);
}
/**
* Dump data currently in Configure into $filename. The serialization format
* is decided by the config reader attached as $config. For example, if the
* 'default' adapter is a PhpReader, the generated file will be a PHP
* configuration file loadable by the PhpReader.
*
* ## Usage
*
* Given that the 'default' reader is an instance of PhpReader.
* Save all data in Configure to the file `my_config.php`:
*
* `Configure::dump('my_config.php', 'default');`
*
* Save only the error handling configuration:
*
* `Configure::dump('error.php', 'default', array('Error', 'Exception');`
*
* @param string $key The identifier to create in the config adapter.
* This could be a filename or a cache key depending on the adapter being used.
* @param string $config The name of the configured adapter to dump data with.
* @param array $keys The name of the top-level keys you want to dump.
* This allows you save only some data stored in Configure.
* @return boolean success
* @throws Cake\Error\ConfigureException if the adapter does not implement a `dump` method.
*/
public static function dump($key, $config = 'default', $keys = array()) {
$reader = static::_getReader($config);
if (!$reader) {
throw new Error\ConfigureException(__d('cake', 'There is no "%s" adapter.', $config));
}
if (!method_exists($reader, 'dump')) {
throw new Error\ConfigureException(__d('cake', 'The "%s" adapter, does not have a dump() method.', $config));
}
$values = static::$_values;
if (!empty($keys) && is_array($keys)) {
$values = array_intersect_key($values, array_flip($keys));
}
return (bool)$reader->dump($key, $values);
}
/**
* Get the configured reader. Internally used by `Configure::load()` and `Configure::dump()`
* Will create new PhpReader for default if not configured yet.
*
* @param string $config The name of the configured adapter
* @return mixed Reader instance or false
*/
protected static function _getReader($config) {
if (!isset(static::$_readers[$config])) {
if ($config !== 'default') {
return false;
}
static::config($config, new PhpReader());
}
return static::$_readers[$config];
}
/**
* Used to determine the current version of CakePHP.
*
* Usage `Configure::version();`
*
* @return string Current version of CakePHP
*/
public static function version() {
if (!isset(static::$_values['Cake']['version'])) {
require CAKE . 'Config/config.php';
static::write($config);
}
return static::$_values['Cake']['version'];
}
/**
* Used to write runtime configuration into Cache. Stored runtime configuration can be
* restored using `Configure::restore()`. These methods can be used to enable configuration managers
* frontends, or other GUI type interfaces for configuration.
*
* @param string $name The storage name for the saved configuration.
* @param string $cacheConfig The cache configuration to save into. Defaults to 'default'
* @param array $data Either an array of data to store, or leave empty to store all values.
* @return boolean Success
*/
public static function store($name, $cacheConfig = 'default', $data = null) {
if ($data === null) {
$data = static::$_values;
}
return Cache::write($name, $data, $cacheConfig);
}
/**
* Restores configuration data stored in the Cache into configure. Restored
* values will overwrite existing ones.
*
* @param string $name Name of the stored config file to load.
* @param string $cacheConfig Name of the Cache configuration to read from.
* @return boolean Success.
*/
public static function restore($name, $cacheConfig = 'default') {
$values = Cache::read($name, $cacheConfig);
if ($values) {
return static::write($values);
}
return false;
}
/**
* Clear all values stored in Configure.
*
* @return boolean success.
*/
public static function clear() {
static::$_values = array();
return true;
}
/**
* Set the error and exception handlers.
*
* @param array $error The Error handling configuration.
* @param array $exception The exception handling configuration.
* @return void
*/
public static function setErrorHandlers($error = null, $exception = null) {
if (!$error) {
$error = self::$_values['Error'];
}
if (!$exception) {
$exception = self::$_values['Exception'];
}
$level = -1;
if (isset($error['level'])) {
error_reporting($error['level']);
$level = $error['level'];
}
if (!empty($error['handler'])) {
set_error_handler($error['handler'], $level);
}
if (!empty($exception['handler'])) {
set_exception_handler($exception['handler']);
}
}
}