{277} - 3.4.3.1 Configure Methods

write(string $key, mixed $value)

Use write() to store data in the application’s configuration.

<?php
 
Configure::write('Company.name','Pizza, Inc.');
Configure::write('Company.slogan','Pizza for your body and soul');
 
?>
  1. <?php
  2. Configure::write('Company.name','Pizza, Inc.');
  3. Configure::write('Company.slogan','Pizza for your body and soul');
  4. ?>

Note the usage of dot notation in the $key parameter. You can use this notation to organize your configuration into logical groups.

The above example could also be written in a single call:

<?php
 
Configure::write(
    'Company',array('name'=>'Pizza, Inc.','slogan'=>'Pizza for your body and soul')
);
 
?>
  1. <?php
  2. Configure::write(
  3. 'Company',array('name'=>'Pizza, Inc.','slogan'=>'Pizza for your body and soul')
  4. );
  5. ?>

You can use Configure::write(‘debug’, $int) to switch between debug and production modes on the fly. This is especially handy for AMF or SOAP interactions where debugging information can cause parsing problems.

read(string $key = ‘debug’)

Used to read configuration data from the application. Defaults to CakePHP’s important debug value. If a key is supplied, the data is returned. Using our examples from write() above, we can read that data back:

<?php
 
Configure::read(‘Company.name’);    //yields: ‘Pizza, Inc.’
Configure::read(‘Company.slogan’);  //yields: ‘Pizza for your body and soul’
 
Configure::read(‘Company’);
 
//yields:
 
array(‘name’ => ‘Pizza, Inc.’, ‘slogan’ => ‘Pizza for your body and soul’);
 
?>
  1. <?php
  2. Configure::read(‘Company.name’); //yields: ‘Pizza, Inc.’
  3. Configure::read(‘Company.slogan’); //yields: ‘Pizza for your body and soul’
  4. Configure::read(‘Company’);
  5. //yields:
  6. array(‘name’ => ‘Pizza, Inc., ‘slogan’ => ‘Pizza for your body and soul’);
  7. ?>
delete(string $key)

Used to delete information from the application’s configuration.

<?php Configure::delete('Company.name'); ?>
  1. <?php Configure::delete('Company.name'); ?>
load(string $path)

Use this method to load configuration information from a specific file.

/app/config/messages.php:
 
<?php
$config['Company’][‘name'] = 'Pizza, Inc.';
$config['Company’][‘slogan'] = 'Pizza for your body and soul';
$config['Company’][‘phone'] = '555-55-55';
?>
 
<?php
Configure::load(‘messages’);
Configure::read(‘Company.name’);
?>
  1. /app/config/messages.php:
  2. <?php
  3. $config['Company’][‘name'] = 'Pizza, Inc.';
  4. $config['Company’][‘slogan'] = 'Pizza for your body and soul';
  5. $config['Company’][‘phone'] = '555-55-55';
  6. ?>
  7. <?php
  8. Configure::load(‘messages’);
  9. Configure::read(‘Company.name’);
  10. ?>

Note that every configure key-value pair is represented in the file with the $configure array. Any other variables in the file will be ignored by the load() function.

version()

Returns the CakePHP version for the current application.

{1381} - 3.4.3.1 Configure Methods

Differences

Lines: 1-92Lines: 1-2
 <title>Configure Methods</title> <title>Configure Methods</title>
-<div class="method">
write(string $key, mixed $value)
</div>
<p>
Use write() to store data in the application’s configuration.
</p>
<pre>
&lt;?php

Configure::write('Company.name','Pizza, Inc.');
Configure::write('Company.slogan','Pizza for your body and soul');

?&gt;
</pre>
<p>
Note the usage of dot notation in the $key parameter. You can use this notation to organize your configuration into logical groups.
</p>
<p>
The above example could also be written in a single call:
</p>
<pre>
&lt;?php

Configure::write(
'Company',array('name'=&gt;'Pizza, Inc.','slogan'=&gt;'Pizza for your body and soul')
);

?&gt;
</pre>
<p>
You can use Configure::write(‘debug’, $int) to switch between debug and production modes on the fly. This is especially handy for AMF or SOAP interactions where debugging information can cause parsing problems.
</p>
<div class="method">
read(string $key = ‘debug’)
</div>
<p>
Used to read configuration data from the application. Defaults to CakePHP’s important debug value. If a key is supplied, the data is returned. Using our examples from write() above, we can read that data back:
</p>
<pre>
&lt;?php

Configure::read(‘Company.name’); //yields: ‘Pizza, Inc.’
Configure::read(‘Company.slogan’); //yields: ‘Pizza for your body and soul’

Configure::read(‘Company’);

//yields:

array(‘name’ => ‘Pizza, Inc.’, ‘slogan’ => ‘Pizza for your body and soul’);

?&gt;
</pre>
<div class="method">
delete(string $key)
</div>
<p>
Used to delete information from the application’s configuration.
</p>
<pre>
&lt;?php Configure::delete('Company.name'); ?&gt;
</pre>
<div class="method">
load(string $path)
</div>
<p>
Use this method to load configuration information from a specific file.
</p>
<pre>
/app/config/messages.php:

&lt;?php
$config['Company’][‘name'] = 'Pizza, Inc.';
$config['Company’][‘slogan'] = 'Pizza for your body and soul';
$config['Company’][‘phone'] = '555-55-55';
?&gt;

&lt;?php
Configure::load(‘messages’);
Configure::read(‘Company.name’);
?&gt;
</pre>
<p>
Note that every configure key-value pair is represented in the file with the $configure array. Any other variables in the file will be ignored by the load() function.
</p>
<div class="method">
version()
</div>
<p>
Returns the CakePHP version for the current application.
</p>
+<p></p>