Zeta Components - high quality PHP components

A typical usage for retrieving the settings in an application:

1.  $conf = new ezcConfiguration();
2.  if ( $conf->hasSettings( 'Colors', array( 'Background', 'Foreground' ) ) )
3.  {
4.      $colorBg = $conf->getSetting( 'Colors', 'Background' );
5.      $colorFg = $conf->getIntSetting( 'Colors', 'Foreground' );
6.  }

A typical usage for storing the settings of an application:

1.  // $conf contains an ezcConfiguration object
2.  $conf->setSetting( 'Colors', 'Background', 'blue' );
3.  $conf->setSetting( 'Fonts', 'PointSize', 12 );
4.  
5.  $conf->setSettings( 'DB',
6.                      array( 'Host', 'User', 'Password' ),
7.                      array( 'localhost', 'dr', 'eXaMpLe' ) );

The current groups and their settings can be examined with:

1.  // $conf contains an ezcConfiguration object
2.  $groups = $conf->getGroupNames();
3.  foreach ( $groups as $group )
4.  {
5.     $settings = $conf->getSettingNames( $group );
6.     foreach ( $settings as $setting )
7.     {
8.         $value = $conf->getSetting( $group, $setting );
9.         print "$group:$setting=$value\n";
10.     }
11.  }

Alternatively all settings and their values can be returned in one go:

1.  // $conf contains an ezcConfiguration object
2.  $settings = $conf->getSettingsInGroup( 'Colors' );
3.  foreach ( $settings as $setting => $value )
4.  {
5.     print "$setting=$value\n";
6.  }

Or quering the entire configuration settings with getAllSettings():

1.  // $conf contains an ezcConfiguration object
2.  $allSettings = $conf->getAllSettings( 'Colors' );
3.  foreach ( $allSettings as $group => $settings )
4.  {
5.     foreach ( $settings as $setting => $value )
6.     {
7.         print "$group:$setting=$value\n";
8.     }
9.  }

Fetching specific settings is done using getSetting() or if you want to ensure that it is a specific type use getBoolSetting(), getIntSetting(), getFloatSetting(), getNumberSetting(), getStringSetting() or getArraySetting(). Fetching multiple values is possible with getSettings().

Removing entries is possible with removeSetting(), removeSettings(), removeGroup() and removeAllSettings().

In addition all entries can queried for existance with hasSetting(), hasSettings() and hasGroup().

Reading and writing is done by the various implemenations of ezcConfigurationReader and ezcConfigurationWriter respectively. They provide access to different configuration formats and storage types, for instance INI files and database storage.

If the application does not need to have such finegrained control over the settings the ezcConfigurationManager class might be of interest.

Initializes the configuration object with the groups and the comments. The $settings array contains all the setting groups. The $comments array has the same format. See ezcConfiguration::$settings and ezcConfiguration::$comments for an example of the layout.

The returned array looks like:

1.  array( 'group1' => array( '#' => 'groupcomment',
2.                            'setting1' => 'comment1',
3.                            'setting2' => 'comment2' ),
4.         'group2' => array( 'setting3' => 'comment3' ) );

The returned array looks like:

1.  array( 'group1' => array( 'setting1' => 'value1',
2.                            'setting2' => 'value2' ),
3.         'group2' => array( 'setting3' => 'value3' ) );

Uses the getSetting() method to fetch the value, this method can throw exceptions. This method also validates whether the value is actually an array value.

Uses the getSetting() method to fetch the value, this method can throw exceptions. This method also validates whether the value is actually a boolean value.

This method returns the comment belonging to the setting that is passed. If there is no comment for this specific setting it returns false.

This method returns the comments belonging to the settings that are passed. If there is no comment for each specific setting the returning array element will have a value of false.

Uses the getSetting() method to fetch the value, this method can throw exceptions. This method also validates whether the value is actually an integer or float value.

For each of the setting names passed in the $settings array it will return the setting in the returned array with the name of the setting as key.

Uses the getSetting() method to fetch the value, this method can throw exceptions. This method also validates whether the value is actually a string value.

If the setting does not already exists it will be created.

If the settings do not already exists it will be created.