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
Location: Cake/Configure/PhpReader.php
Properties summary
-
$_pathprotectedstringThe path this reader finds files on.
Method Summary
-
__construct() public
Constructor for PHP Config file reading. -
_getFilePath() protected
Get file path -
dump() public
Converts the provided $data into a string of PHP code that can be used saved into a file and loaded later.
-
read() public
Read a config file and return its contents.
Method Detail
__construct() 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
_getFilePath() 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
Full file path
dump() 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
Bytes saved.
Implementation of
read() 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 App::pluginPath().
Parameters
- string $key
The identifier to read from. If the key has a . it will be treated as a plugin prefix.
Returns
Parsed configuration values.
Throws
ConfigureExceptionwhen files don't exist or they don't contain $config.
Or when files contain '..' as this could lead to abusive reads.