<?php /** * PhpReader file * * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org) * * Licensed under The MIT License * For full copyright and license information, please see the LICENSE.txt * Redistributions of files must retain the above copyright notice * * @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org) * @link http://book.cakephp.org/2.0/en/development/configuration.html#loading-configuration-files CakePHP(tm) Configuration * @package Cake.Configure * @since CakePHP(tm) v 2.0 * @license http://www.opensource.org/licenses/mit-license.php MIT License */ /** * PHP Reader allows Configure to load configuration values from * files containing simple PHP arrays. * * Files compatible with PhpReader should define a `$config` variable, that * contains all of the configuration data contained in the file. * * @package Cake.Configure */ class PhpReader implements ConfigReaderInterface { /** * The path this reader finds files on. * * @var string */ protected $_path = null; /** * Constructor for PHP Config file reading. * * @param string $path The path to read config files from. Defaults to APP . 'Config' . DS */ public function __construct($path = null) { if (!$path) { $path = APP . 'Config' . DS; } $this->_path = $path; } /** * Read a config file and return its contents. * * Files with `.` in the name will be treated as values in plugins. Instead of reading from * the initialized path, plugin keys will be located using App::pluginPath(). * * @param string $key The identifier to read from. If the key has a . it will be treated * as a plugin prefix. * @return array Parsed configuration values. * @throws ConfigureException when files don't exist or they don't contain `$config`. * Or when files contain '..' as this could lead to abusive reads. */ public function read($key) { if (strpos($key, '..') !== false) { throw new ConfigureException(__d('cake_dev', 'Cannot load configuration files with ../ in them.')); } $file = $this->_getFilePath($key); if (!is_file($file)) { throw new ConfigureException(__d('cake_dev', 'Could not load configuration file: %s', $file)); } include $file; if (!isset($config)) { throw new ConfigureException(__d('cake_dev', 'No variable %s found in %s', '$config', $file)); } return $config; } /** * Converts the provided $data into a string of PHP code that can * be used saved into a file and loaded later. * * @param string $key The identifier to write to. If the key has a . it will be treated * as a plugin prefix. * @param array $data Data to dump. * @return integer Bytes saved. */ public function dump($key, $data) { $contents = '<?php' . "\n" . '$config = ' . var_export($data, true) . ';'; $filename = $this->_getFilePath($key); return file_put_contents($filename, $contents); } /** * Get file path * * @param string $key The identifier to write to. If the key has a . it will be treated * as a plugin prefix. * @return string Full file path */ protected function _getFilePath($key) { if (substr($key, -4) === '.php') { $key = substr($key, 0, -4); } list($plugin, $key) = pluginSplit($key); $key .= '.php'; if ($plugin) { $file = App::pluginPath($plugin) . 'Config' . DS . $key; } else { $file = $this->_path . $key; } return $file; } }