Configuration class. Used for managing runtime configuration information.
Provides features for reading and writing to the runtime configuration, as well as methods for loading additional configuration files or storing runtime configuration for future use.
_getEngine( string $config )
Get the configured engine. Internally used by Configure::load()
and Configure::dump()
Will create new PhpConfig for default if not configured yet.
$config
Cake\Core\Configure\ConfigEngineInterface|false
check( string $var )
Returns true if given variable is set in Configure.
$var
boolean
config( string $name , Cake\Core\Configure\ConfigEngineInterface $engine )
Add a new engine to Configure. Engines allow you to read configuration files in various formats/storage locations. CakePHP comes with two built-in engines PhpConfig and IniConfig. You can also implement your own engine classes in your application.
To add a new engine to Configure:
Configure::config('ini', new IniConfig());
$name
Cake\Core\Configure\ConfigEngineInterface
$engine
configured( string|null $name null )
Gets the names of the configured Engine objects.
$name
optional null array
consume( string $var )
Used to read and delete a variable from Configure.
This is primarily used during bootstrapping to move configuration data out of configure into the various other classes in CakePHP.
$var
array|null
delete( string $var )
Used to delete a variable from Configure.
Usage:
Configure::delete('Name'); will delete the entire Configure::Name Configure::delete('Name.key'); will delete only the Configure::Name[key]
$var
drop( string $name )
Remove a configured engine. This will unset the engine and make any future attempts to use it cause an Exception.
$name
boolean
dump( string $key , string $config 'default' , array $keys [] )
Dump data currently in Configure into $key. The serialization format is decided by the config engine attached as $config. For example, if the 'default' adapter is a PhpConfig, the generated file will be a PHP configuration file loadable by the PhpConfig.
Given that the 'default' engine is an instance of PhpConfig. Save all data in Configure to the file my_config.php
:
Configure::dump('my_config', 'default');
Save only the error handling configuration:
Configure::dump('error', 'default', ['Error', 'Exception'];
$key
$config
optional 'default' $keys
optional [] boolean
Cake\Core\Exception\Exception
dump
method.load( string $key , string $config 'default' , boolean $merge true )
Loads stored configuration information from a resource. You can add config file resource engines with Configure::config()
.
Loaded configuration information will be merged with the current runtime configuration. You can load configuration files from plugins by preceding the filename with the plugin name.
Configure::load('Users.user', 'default')
Would load the 'user' config file using the default config engine. You can load app config files by giving the name of the resource you want loaded.
Configure::load('setup', 'default');
If using default
config and no engine has been configured for it yet, one will be automatically created using PhpConfig
$key
$config
optional 'default' $merge
optional true boolean
read( string $var null )
Used to read information stored in Configure. It's not possible to store null
values in Configure.
Usage:
Configure::read('Name'); will return all values for Name Configure::read('Name.key'); will return only the value of Configure::Name[key]
$var
optional null mixed
readOrFail( string $var )
Used to get information stored in Configure. It's not possible to store null
values in Configure.
Acts as a wrapper around Configure::read() and Configure::check(). The configure key/value pair fetched via this method is expected to exist. In case it does not an exception will be thrown.
Usage:
Configure::readOrFail('Name'); will return all values for Name Configure::readOrFail('Name.key'); will return only the value of Configure::Name[key]
$var
mixed
RuntimeException
restore( string $name , string $cacheConfig 'default' )
Restores configuration data stored in the Cache into configure. Restored values will overwrite existing ones.
$name
$cacheConfig
optional 'default' boolean
store( string $name , string $cacheConfig 'default' , array $data null )
Used to write runtime configuration into Cache. Stored runtime configuration can be restored using Configure::restore()
. These methods can be used to enable configuration managers frontends, or other GUI type interfaces for configuration.
$name
$cacheConfig
optional 'default' $data
optional null boolean
version( )
Used to determine the current version of CakePHP.
Usage
Configure::version();
string
write( string|array $config , mixed $value null )
Used to store a dynamic variable in Configure.
Usage:
Configure::write('One.key1', 'value of the Configure::One[key1]'); Configure::write(['One.key1' => 'value of the Configure::One[key1]']); Configure::write('One', [ 'key1' => 'value of the Configure::One[key1]', 'key2' => 'value of the Configure::One[key2]' ]); Configure::write([ 'One.key1' => 'value of the Configure::One[key1]', 'One.key2' => 'value of the Configure::One[key2]' ]);
$config
$value
optional null boolean
© 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/3.1/class-Cake.Core.Configure.html