1: <?php
2: /**
3: * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
4: * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
5: *
6: * Licensed under The MIT License
7: * For full copyright and license information, please see the LICENSE.txt
8: * Redistributions of files must retain the above copyright notice.
9: *
10: * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
11: * @link https://cakephp.org CakePHP(tm) Project
12: * @since 1.0.0
13: * @license https://opensource.org/licenses/mit-license.php MIT License
14: */
15: namespace Cake\Core\Configure;
16:
17: /**
18: * An interface for creating objects compatible with Configure::load()
19: */
20: interface ConfigEngineInterface
21: {
22:
23: /**
24: * Read a configuration file/storage key
25: *
26: * This method is used for reading configuration information from sources.
27: * These sources can either be static resources like files, or dynamic ones like
28: * a database, or other datasource.
29: *
30: * @param string $key Key to read.
31: * @return array An array of data to merge into the runtime configuration
32: */
33: public function read($key);
34:
35: /**
36: * Dumps the configure data into the storage key/file of the given `$key`.
37: *
38: * @param string $key The identifier to write to.
39: * @param array $data The data to dump.
40: * @return bool True on success or false on failure.
41: */
42: public function dump($key, array $data);
43: }
44: