ConfigReaderInterface.php 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. <?php
  2. /**
  3. * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  4. * Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
  5. *
  6. * Licensed under The MIT License
  7. * Redistributions of files must retain the above copyright notice.
  8. *
  9. * @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
  10. * @link http://cakephp.org CakePHP(tm) Project
  11. * @package Cake.Core
  12. * @since CakePHP(tm) v 1.0.0.2363
  13. * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  14. */
  15. /**
  16. * An interface for creating objects compatible with Configure::load()
  17. *
  18. * @package Cake.Core
  19. */
  20. interface ConfigReaderInterface {
  21. /**
  22. * Read method is used for reading configuration information from sources.
  23. * These sources can either be static resources like files, or dynamic ones like
  24. * a database, or other datasource.
  25. *
  26. * @param string $key
  27. * @return array An array of data to merge into the runtime configuration
  28. */
  29. public function read($key);
  30. /**
  31. * Dumps the configure data into source.
  32. *
  33. * @param string $key The identifier to write to.
  34. * @param array $data The data to dump.
  35. * @return boolean True on success or false on failure.
  36. */
  37. public function dump($key, $data);
  38. }