1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.parse-ini-string" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>parse_ini_string</refname>
<refpurpose>Parse a configuration string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>parse_ini_string</methodname>
<methodparam><type>string</type><parameter>ini_string</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>process_sections</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scanner_mode</parameter><initializer><constant>INI_SCANNER_NORMAL</constant></initializer></methodparam>
</methodsynopsis>
<para>
<function>parse_ini_string</function> returns the settings in string
<parameter>ini_string</parameter> in an associative array.
</para>
<para>
The structure of the ini string is the same as the &php.ini;'s.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ini_string</parameter></term>
<listitem>
<para>
The contents of the ini file being parsed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>process_sections</parameter></term>
<listitem>
<para>
By setting the <parameter>process_sections</parameter>
parameter to &true;, you get a multidimensional array, with
the section names and settings included. The default
for <parameter>process_sections</parameter> is &false;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>scanner_mode</parameter></term>
<listitem>
<para>
Can either be <constant>INI_SCANNER_NORMAL</constant> (default) or
<constant>INI_SCANNER_RAW</constant>. If <constant>INI_SCANNER_RAW</constant>
is supplied, then option values will not be parsed.
</para>
&ini.scanner.typed;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The settings are returned as an associative <type>array</type> on success,
and &false; on failure.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<simpara>
There are reserved words which must not be used as keys for
ini files. These include: <literal>null</literal>, <literal>yes</literal>,
<literal>no</literal>, <literal>true</literal>, <literal>false</literal>,
<literal>on</literal>, <literal>off</literal>, <literal>none</literal>.
Values <literal>null</literal>, <literal>off</literal>, <literal>no</literal> and
<literal>false</literal> result in <literal>""</literal>, and values
<literal>on</literal>, <literal>yes</literal> and <literal>true</literal> result
in <literal>"1"</literal>, unless <constant>INI_SCANNER_TYPED</constant> mode is used.
Characters <literal>?{}|&~