The Yaf_Config_Ini class

    (Yaf >=1.0.0)

    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

    classYaf_Config_IniextendsYaf_Config_AbstractimplementsIterator, ArrayAccess, Countable {
    public__construct(string$config_file, string$section = ?)
    publiccount(): void
    publiccurrent(): void
    public__get(string$name = ?): void
    public__isset(string$name): void
    publickey(): void
    publicnext(): void
    publicoffsetExists(string$name): void
    publicoffsetGet(string$name): void
    publicoffsetSet(string$name, string$value): void
    publicoffsetUnset(string$name): void
    publicreadonly(): void
    publicrewind(): void
    public__set(string$name, mixed$value): void
    publictoArray(): array
    publicvalid(): void
    abstractpublicYaf_Config_Abstract::get(string$name, mixed$value): mixed
    abstractpublicYaf_Config_Abstract::readonly(): bool
    abstractpublicYaf_Config_Abstract::set(): Yaf_Config_Abstract
    abstractpublicYaf_Config_Abstract::toArray(): array
    }

    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

    Table of Contents

    To Top