$_values
$_values : array
Array of values currently stored in Configure.
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.
$_engines : array<mixed,\Cake\Core\Configure\ConfigEngineInterface>
Configured engine classes, used to load config files from resources
write(string|array $config, mixed $value = null) : boolean
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]'
]);| string|array | $config | The key to write, can be a dot notation value. Alternatively can be an array containing key(s) and value(s). |
| mixed | $value | Value to set for var |
True if write was successful
read(string|null $var = null, mixed $default = null) : mixed
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]| string|null | $var | Variable to obtain. Use '.' to access array elements. |
| mixed | $default | The return value when the configure does not exist |
Value stored in configure, or null.
readOrFail(string $var) : mixed
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]| string | $var | Variable to obtain. Use '.' to access array elements. |
if the requested configuration is not set.
Value stored in configure.
consumeOrFail(string $var) : mixed
Used to consume information stored in Configure. It's not possible to store `null` values in Configure.
Acts as a wrapper around Configure::consume() and Configure::check(). The configure key/value pair consumed via this method is expected to exist. In case it does not an exception will be thrown.
| string | $var | Variable to consume. Use '.' to access array elements. |
if the requested configuration is not set.
Value stored in configure.
consume(string $var) : array|string|null
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.
| string | $var | The key to read and remove. |
config(string $name, \Cake\Core\Configure\ConfigEngineInterface $engine) : void
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());| string | $name | The name of the engine being configured. This alias is used later to read values from a specific engine. |
| \Cake\Core\Configure\ConfigEngineInterface | $engine | The engine to append. |
configured(string|null $name = null) : array|boolean
Gets the names of the configured Engine objects.
Checking if a specific engine has been configured with this method is deprecated. Use Configure::isConfigured() instead.
| string|null | $name | Engine name. |
Array of the configured Engine objects, bool for specific name.
load(string $key, string $config = 'default', boolean $merge = true) : boolean
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
| string | $key | name of configuration resource to load. |
| string | $config | Name of the configured engine to use to read the resource identified by $key. |
| boolean | $merge | if config files should be merged instead of simply overridden |
False if file not found, true if load successful.
dump(string $key, string $config = 'default', array $keys = array()) : boolean
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'];| string | $key | The identifier to create in the config adapter. This could be a filename or a cache key depending on the adapter being used. |
| string | $config | The name of the configured adapter to dump data with. |
| array | $keys | The name of the top-level keys you want to dump. This allows you save only some data stored in Configure. |
if the adapter does not implement a dump method.
Success
store(string $name, string $cacheConfig = 'default', array|null $data = null) : boolean
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.
| string | $name | The storage name for the saved configuration. |
| string | $cacheConfig | The cache configuration to save into. Defaults to 'default' |
| array|null | $data | Either an array of data to store, or leave empty to store all values. |
Success
restore(string $name, string $cacheConfig = 'default') : boolean
Restores configuration data stored in the Cache into configure. Restored values will overwrite existing ones.
| string | $name | Name of the stored config file to load. |
| string | $cacheConfig | Name of the Cache configuration to read from. |
Success.
_getEngine(string $config) : \Cake\Core\Configure\ConfigEngineInterface|false
Get the configured engine. Internally used by `Configure::load()` and `Configure::dump()` Will create new PhpConfig for default if not configured yet.
| string | $config | The name of the configured adapter |
Engine instance or false