parse_ini_string

Parse a configuration string

&reftitle.description; ``array``false```parse_ini_string` `string` `ini_string` `bool` `process_sections`&false; `int` `scanner_mode` `INI_SCANNER_NORMAL`

`parse_ini_string` returns the settings in string `ini_string` in an associative array.

The structure of the ini string is the same as the &php.ini;'s.

&reftitle.parameters;

`ini_string`

- 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.

  &ini.scanner.typed;
&reftitle.returnvalues;

The settings are returned as an associative `array` on success, and &false; on failure.

&reftitle.notes;

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.

&reftitle.seealso;

- `parse_ini_file`