Class IniReader
Ini file configuration parser. Since IniReader uses parse_ini_file underneath, you should be aware that this class shares the same behavior, especially with regards to boolean and null values.
In addition to the native parse_ini_file features, IniReader also allows you
to create nested array structures through usage of .
delimited names. This allows
you to create nested arrays structures in an ini config file. For example:
db.password = secret
would turn into array('db' => array('password' => 'secret'))
You can nest properties as deeply as needed using .
's. In addition to using .
you
can use standard ini section notation to create nested structures:
{{{ [section] key = value }}}
Once loaded into Configure, the above would be accessed using:
`Configure::read('section.key');
You can combine .
separated values with sections to create more deeply
nested structures.
IniReader also manipulates how the special ini values of 'yes', 'no', 'on', 'off', 'null' are handled. These values will be converted to their boolean equivalents.
- IniReader implements ConfigReaderInterface
See: http://php.net/parse_ini_file
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: Cake/Configure/IniReader.php
Properties summary
Method Summary
-
__construct() public
Build and construct a new ini file parser. The parser can be used to read ini files that are on the filesystem.
-
_parseNestedValues() protected
parses nested values out of keys. -
read() public
Read an ini file and return the results as an array.
Method Detail
__construct() public ¶
__construct( string $path , string $section = null )
Build and construct a new ini file parser. The parser can be used to read ini files that are on the filesystem.
Parameters
- string $path
- Path to load ini config files from.
- string $section optional null
Only get one section, leave null to parse and fetch all sections in the ini file.
_parseNestedValues() protected ¶
_parseNestedValues( array $values )
parses nested values out of keys.
Parameters
- array $values
- Values to be exploded.
Returns
Array of values exploded