PHP engine allows Configure to load configuration values from files containing simple PHP arrays.
Files compatible with PhpConfig should return an array that contains all of the configuration data contained in the file.
An example configuration file would look like::
<?php return [ 'debug' => 0, 'Security' => [ 'salt' => 'its-secret' ], 'App' => [ 'namespace' => 'App' ] ];
$_extension
protected string
Converts the provided $data into a string of PHP code that can be used saved into a file and loaded later.
__construct( string|null $path null )
Constructor for PHP Config file reading.
$path
optional null 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.
$key
The identifier to write to. If the key has a . it will be treated as a plugin prefix.
$data
Cake\Core\Configure\ConfigEngineInterface::dump()
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 Plugin::path().
Setting a $config
variable is deprecated. Use return
instead.
$key
The identifier to read from. If the key has a . it will be treated as a plugin prefix.
Cake\Core\Exception\Exception
when files don't exist or they don't contain $config
. Or when files contain '..' as this could lead to abusive reads.
Cake\Core\Configure\ConfigEngineInterface::read()
_getFilePath( string $key , boolean $checkExists false )
Get file path
$key
The identifier to write to. If the key has a . it will be treated as a plugin prefix.
$checkExists
optional false Cake\Core\Exception\Exception
When files don't exist or when files contain '..' as this could lead to abusive reads.
© 2005–2017 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.
https://api.cakephp.org/3.4/class-Cake.Core.Configure.Engine.PhpConfig.html