Introduction

Yaf_Config_Ini enables developers to store configuration data in a familiar INI format and read them in the application by using nested object property syntax. The INI format is specialized to provide both the ability to have a hierarchy of configuration data keys and inheritance between configuration data sections. Configuration data hierarchies are supported by separating the keys with the dot or period character ("."). A section may extend or inherit from another section by following the section name with a colon character (":") and the name of the section from which data are to be inherited.

Note:
Yaf_Config_Ini utilizes the » parse_ini_file() PHP function. Please review this documentation to be aware of its specific behaviors, which propagate to Yaf_Config_Ini, such as how the special values of "TRUE", "FALSE", "yes", "no", and "NULL" are handled.

Class synopsis

Yaf_Config_Ini extends Yaf_Config_Abstract implements Iterator , Traversable , ArrayAccess , Countable {

/* Properties */

/* Methods */

public __construct ( string $config_file [, string $section ] )

public void count ( void )

public void current ( void )

public void __get ([ string $name ] )

public void __isset ( string $name )

public void key ( void )

public void next ( void )

public void offsetExists ( string $name )

public void offsetGet ( string $name )

public void offsetSet ( string $name , string $value )

public void offsetUnset ( string $name )

public void readonly ( void )

public void rewind ( void )

public void __set ( string $name , mixed $value )

public array toArray ( void )

public void valid ( void )

/* Inherited methods */

abstract public mixed Yaf_Config_Abstract::get ( string $name , mixed $value )

abstract public bool Yaf_Config_Abstract::readonly ( void )

abstract public Yaf_Config_Abstract Yaf_Config_Abstract::set ( void )

abstract public array Yaf_Config_Abstract::toArray ( void )

}

Properties

_config
_readonly

Examples

Example #1 Yaf_Config_Ini()example

This example illustrates a basic use of Yaf_Config_Ini for loading configuration data from an INI file. In this example there are configuration data for both a production system and for a staging system. Because the staging system configuration data are very similar to those for production, the staging section inherits from the production section. In this case, the decision is arbitrary and could have been written conversely, with the production section inheriting from the staging section, though this may not be the case for more complex situations. Suppose, then, that the following configuration data are contained in /path/to/config.ini:

; Production site configuration data
[production]
webhost                  = www.example.com
database.adapter         = pdo_mysql
database.params.host     = db.example.com
database.params.username = dbuser
database.params.password = secret
database.params.dbname   = dbname
 
; Staging site configuration data inherits from production and
; overrides values as necessary
[staging : production]
database.params.host     = dev.example.com
database.params.username = devuser
database.params.password = devsecret


<?php
$config = new Yaf_Config_Ini('/path/to/config.ini', 'staging');
 
var_dump($config->database->params->host); 
var_dump($config->database->params->dbname);
var_dump($config->get("database.params.username"));
?>

The above example will output something similar to:

string(15) "dev.example.com"
string(6) "dbname"
string(7) "devuser

Yaf_Config_Ini::__construct — Yaf_Config_Ini constructor
Yaf_Config_Ini::count — The count purpose
Yaf_Config_Ini::current — The current purpose
Yaf_Config_Ini::__get — The __get purpose
Yaf_Config_Ini::__isset — The __isset purpose
Yaf_Config_Ini::key — The key purpose
Yaf_Config_Ini::next — The next purpose
Yaf_Config_Ini::offsetExists — The offsetExists purpose
Yaf_Config_Ini::offsetGet — The offsetGet purpose
Yaf_Config_Ini::offsetSet — The offsetSet purpose
Yaf_Config_Ini::offsetUnset — The offsetUnset purpose
Yaf_Config_Ini::readonly — The readonly purpose
Yaf_Config_Ini::rewind — The rewind purpose
Yaf_Config_Ini::__set — The __set purpose
Yaf_Config_Ini::toArray — Returns a PHP array
Yaf_Config_Ini::valid — The valid purpose

Yaf_Config_Abstract::toArray

Yaf_Config_Ini::__construct

Yaf

PHP Manual

The Yaf_Config_Ini class

Introduction

Class synopsis

Properties

Examples

Table of Contents