Class PhpReader
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.
- PhpReader implements ConfigReaderInterface
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Located at Cake/Configure/PhpReader.php
Method Detail
__constructsource public
__construct( string $path null )
Constructor for PHP Config file reading.
Parameters
- string
$path
optional null - The path to read config files from. Defaults to APP . 'Config' . DS
_getFilePathsource protected
_getFilePath( string $key )
Get file path
Parameters
- string
$key
- The identifier to write to. If the key has a . it will be treated as a plugin prefix.
Returns
string
Full file path
dumpsource public
dump( string $key , array $data )
Converts the provided $data into a string of PHP code that can be used saved into a file and loaded later.
Parameters
- string
$key
- The identifier to write to. If the key has a . it will be treated as a plugin prefix.
- array
$data
- Data to dump.
Returns
integer
Bytes saved.
Implementation of
ConfigReaderInterface::dump()
readsource public
read( string $key )
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 CakePlugin::path().
Parameters
- string
$key
- The identifier to read from. If the key has a . it will be treated as a plugin prefix.
Returns
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.Implementation of
ConfigReaderInterface::read()
Properties summary
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.7/class-PhpReader.html