reference/filesystem/functions/parse-ini-string.xml
0c9c2dd669fe9395eaa73d487fbd160f9057429a
0c9c2dd669fe9395eaa73d487fbd160f9057429a
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.parse-ini-string">
3
+
<refentry xml:id="function.parse-ini-string" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>parse_ini_string</refname>
6
6
<refpurpose>Parse a configuration string</refpurpose>
...
...
@@ -9,14 +9,14 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>array</type><methodname>parse_ini_string</methodname>
13
-
<methodparam><type>string</type><parameter>ini</parameter></methodparam>
14
-
<methodparam choice="opt"><type>bool</type><parameter>process_sections</parameter><initializer>false</initializer></methodparam>
15
-
<methodparam choice="opt"><type>int</type><parameter>scanner_mode</parameter><initializer>INI_SCANNER_NORMAL</initializer></methodparam>
12
+
<type class="union"><type>array</type><type>false</type></type><methodname>parse_ini_string</methodname>
13
+
<methodparam><type>string</type><parameter>ini_string</parameter></methodparam>
14
+
<methodparam choice="opt"><type>bool</type><parameter>process_sections</parameter><initializer>&false;</initializer></methodparam>
15
+
<methodparam choice="opt"><type>int</type><parameter>scanner_mode</parameter><initializer><constant>INI_SCANNER_NORMAL</constant></initializer></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
18
<function>parse_ini_string</function> returns the settings in string
19
-
<parameter>ini</parameter> in an associative array.
19
+
<parameter>ini_string</parameter> in an associative array.
20
20
</para>
21
21
<para>
22
22
The structure of the ini string is the same as the &php.ini;'s.
...
...
@@ -28,7 +28,7 @@
28
28
<para>
29
29
<variablelist>
30
30
<varlistentry>
31
-
<term><parameter>ini</parameter></term>
31
+
<term><parameter>ini_string</parameter></term>
32
32
<listitem>
33
33
<para>
34
34
The contents of the ini file being parsed.
...
...
@@ -74,9 +74,13 @@
74
74
<note>
75
75
<simpara>
76
76
There are reserved words which must not be used as keys for
77
-
ini files. These include: null, yes, no, true, false, on, off, none.
78
-
Values null, off, no and false result in "", and values on, yes and true result
79
-
in "1", unless <constant>INI_SCANNER_TYPED</constant> mode is used.
77
+
ini files. These include: <literal>null</literal>, <literal>yes</literal>,
78
+
<literal>no</literal>, <literal>true</literal>, <literal>false</literal>,
79
+
<literal>on</literal>, <literal>off</literal>, <literal>none</literal>.
80
+
Values <literal>null</literal>, <literal>off</literal>, <literal>no</literal> and
81
+
<literal>false</literal> result in <literal>""</literal>, and values
82
+
<literal>on</literal>, <literal>yes</literal> and <literal>true</literal> result
83
+
in <literal>"1"</literal>, unless <constant>INI_SCANNER_TYPED</constant> mode is used.
80
84
Characters <literal>?{}|&~![()^"</literal> must not be used anywhere in
81
85
the key and have a special meaning in the value.
82
86
</simpara>
...
...
@@ -93,7 +97,6 @@
93
97
</refsect1>
94
98
95
99
</refentry>
96
-
97
100
<!-- Keep this comment at the end of the file
98
101
Local variables:
99
102
mode: sgml
100
103