production

YAF_CONFIG_INI(3)							 1							 YAF_CONFIG_INI(3)

The Yaf_Config_Ini class

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 inher-
       itance  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 behav-
	      iors, 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

       Yaf_Config_Iniextends
       Yaf_Config_AbstractIteratorArrayAccessCountable

       Properties

       Methods

       o public Yaf_Config_Ini::__construct (string  $config_file, [string  $section])

       o public void Yaf_Config_Ini::count (void  )

       o public void Yaf_Config_Ini::current (void  )

       o public void Yaf_Config_Ini::__get ([string  $name])

       o public void Yaf_Config_Ini::__isset (string  $name)

       o public void Yaf_Config_Ini::key (void	)

       o public void Yaf_Config_Ini::next (void  )

       o public void Yaf_Config_Ini::offsetExists (string  $name)

       o public void Yaf_Config_Ini::offsetGet (string	$name)

       o public void Yaf_Config_Ini::offsetSet (string	$name, string  $value)

       o public void Yaf_Config_Ini::offsetUnset (string  $name)

       o public void Yaf_Config_Ini::readonly (void  )

       o public void Yaf_Config_Ini::rewind (void  )

       o public void Yaf_Config_Ini::__set (string  $name, mixed  $value)

       o public array Yaf_Config_Ini::toArray (void  )

       o public void Yaf_Config_Ini::valid (void  )

       Inherited methods

       o abstractpublic mixed Yaf_Config_Abstract::get (string	$name, mixed  $value)

       o abstractpublic bool Yaf_Config_Abstract::readonly (void  )

       o abstractpublic Yaf_Config_Abstract Yaf_Config_Abstract::set (void  )

       o abstractpublic array Yaf_Config_Abstract::toArray (void  )

PROPERTIES

	      o $_config
		-

	      o $_readonly
		-

EXAMPLES

       Example #1

	      Yaf_Config_Ini(3)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

PHP Documentation Group 													 YAF_CONFIG_INI(3)