Class Configure

_appDefaults()source protected static

_appDefaults( )

Set app's default configs

_getReader()source protected static

_getReader( string $config )

Get the configured reader. Internally used by Configure::load() and Configure::dump() Will create new PhpReader for default if not configured yet.

Parameters

string $config

The name of the configured adapter

Returns

mixed
Reader instance or false

_setErrorHandlers()source protected static

_setErrorHandlers( array $error , array $exception )

Set the error and exception handlers.

Parameters

array $error

The Error handling configuration.

array $exception

The exception handling configuration.

bootstrap()source public static

bootstrap( boolean $boot true )

Initializes configure and runs the bootstrap process. Bootstrapping includes the following steps:

• Setup App array in Configure.
• Include app/Config/core.php.
• Configure core cache configurations.
• Load App cache files.
• Include app/Config/bootstrap.php.
• Setup error/exception handlers.

Parameters

boolean $boot optional true

Whether to do bootstrapping.

check()source public static

check( string $var )

Returns true if given variable is set in Configure.

Parameters

string $var

Variable name to check for

Returns

boolean
True if variable is there

clear()source public static

clear( )

Clear all values stored in Configure.

Returns

boolean
Success.

config()source public static

config( string $name , ConfigReaderInterface $reader )

Add a new reader to Configure. Readers allow you to read configuration files in various formats/storage locations. CakePHP comes with two built-in readers PhpReader and IniReader. You can also implement your own reader classes in your application.

To add a new reader to Configure:

Configure::config('ini', new IniReader());

Parameters

string $name

The name of the reader being configured. This alias is used later to read values from a specific reader.

ConfigReaderInterface $reader

The reader to append.

configured()source public static

configured( string|null $name null )

Gets the names of the configured reader objects.

Parameters

string|null $name optional null

Name to check. If null returns all configured reader names.

Returns

array
Array of the configured reader objects.

consume()source public static

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.

Parameters

string $var

The key to read and remove.

Returns

array|null

delete()source public static

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]

Parameters

string $var

the var to be deleted

Link

https://book.cakephp.org/2.0/en/development/configuration.html#Configure::delete

drop()source public static

drop( string $name )

Remove a configured reader. This will unset the reader and make any future attempts to use it cause an Exception.

Parameters

string $name

Name of the reader to drop.

Returns

boolean
Success

dump()source public static

dump( string $key , string $config 'default' , array $keys array() )

Dump data currently in Configure into $key. The serialization format is decided by the config reader attached as $config. For example, if the 'default' adapter is a PhpReader, the generated file will be a PHP configuration file loadable by the PhpReader.

Usage

Given that the 'default' reader is an instance of PhpReader. Save all data in Configure to the file my_config.php:

Configure::dump('my_config.php', 'default');

Save only the error handling configuration:

Configure::dump('error.php', 'default', array('Error', 'Exception');

Parameters

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 optional 'default'

The name of the configured adapter to dump data with.

array $keys optional array()

The name of the top-level keys you want to dump. This allows you save only some data stored in Configure.

Returns

boolean
success

Throws

ConfigureException
if the adapter does not implement a dump method.

load()source public static

load( string $key , string $config 'default' , boolean $merge true )

Loads stored configuration information from a resource. You can add config file resource readers 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 reader. 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 reader has been configured for it yet, one will be automatically created using PhpReader

Parameters

string $key

name of configuration resource to load.

string $config optional 'default'

Name of the configured reader to use to read the resource identified by $key.

boolean $merge optional true

if config files should be merged instead of simply overridden

Returns

boolean
False if file not found, true if load successful.

Throws

ConfigureException
Will throw any exceptions the reader raises.

Link

https://book.cakephp.org/2.0/en/development/configuration.html#Configure::load

read()source public static

read( string|null $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]

Parameters

string|null $var optional null

Variable to obtain. Use '.' to access array elements.

Returns

mixed
value stored in configure, or null.

Link

https://book.cakephp.org/2.0/en/development/configuration.html#Configure::read

restore()source public static

restore( string $name , string $cacheConfig 'default' )

Restores configuration data stored in the Cache into configure. Restored values will overwrite existing ones.

Parameters

string $name

Name of the stored config file to load.

string $cacheConfig optional 'default'

Name of the Cache configuration to read from.

Returns

boolean
Success.

store()source public static

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.

Parameters

string $name

The storage name for the saved configuration.

string $cacheConfig optional 'default'

The cache configuration to save into. Defaults to 'default'

array $data optional null

Either an array of data to store, or leave empty to store all values.

Returns

boolean
Success

version()source public static

version( )

Used to determine the current version of CakePHP.

Usage Configure::version();

Returns

string
Current version of CakePHP

write()source public static

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(array('One.key1' => 'value of the Configure::One[key1]'));
Configure::write('One', array(
    'key1' => 'value of the Configure::One[key1]',
    'key2' => 'value of the Configure::One[key2]'
);

Configure::write(array(
    'One.key1' => 'value of the Configure::One[key1]',
    'One.key2' => 'value of the Configure::One[key2]'
));

Parameters

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 optional null

Value to set for var

Returns

boolean
True if write was successful

Link

https://book.cakephp.org/2.0/en/development/configuration.html#Configure::write

array()

array(
    'debug' => 0
)