(PHP 5 >= 5.3.0, PHP 7)
parse_ini_string — Parse a configuration string
$ini
[, bool $process_sections
= false
[, int $scanner_mode
= INI_SCANNER_NORMAL
]] )
parse_ini_string() returns the settings in string
ini
in an associative array.
The structure of the ini string is the same as the php.ini's.
ini
The contents of the ini file being parsed.
process_sections
By setting the process_sections
parameter to TRUE
, you get a multidimensional array, with
the section names and settings included. The default
for process_sections
is FALSE
scanner_mode
Can either be INI_SCANNER_NORMAL
(default) or
INI_SCANNER_RAW
. If INI_SCANNER_RAW
is supplied, then option values will not be parsed.
As of PHP 5.6.1 can also be specified as INI_SCANNER_TYPED
.
In this mode boolean, null and integer types are preserved when possible.
String values "true", "on" and "yes"
are converted to TRUE
. "false", "off", "no"
and "none" are considered FALSE
. "null" is converted to NULL
in typed mode. Also, all numeric strings are converted to integer type if it is possible.
The settings are returned as an associative array on success,
and FALSE
on failure.
Note: There are reserved words which must not be used as keys for ini files. These include: null, yes, no, true, false, on, off, none. Values null, off, no and false result in "", and values on, yes and true result in "1", unless
INI_SCANNER_TYPED
mode is used. Characters ?{}|&~![()^" must not be used anywhere in the key and have a special meaning in the value.