reference/spl/splfileobject/fgetcsv.xml
61374bbe228e8e9c55a24aba59a1e2bb2a871148
61374bbe228e8e9c55a24aba59a1e2bb2a871148
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
4
3
<refentry xml:id="splfileobject.fgetcsv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>SplFileObject::fgetcsv</refname>
...
...
@@ -9,9 +8,9 @@
9
8
10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis>
13
-
<modifier>public</modifier> <type>array</type><methodname>SplFileObject::fgetcsv</methodname>
14
-
<methodparam choice="opt"><type>string</type><parameter>delimiter</parameter><initializer>","</initializer></methodparam>
11
+
<methodsynopsis role="SplFileObject">
12
+
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>SplFileObject::fgetcsv</methodname>
13
+
<methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>","</initializer></methodparam>
15
14
<methodparam choice="opt"><type>string</type><parameter>enclosure</parameter><initializer>"\""</initializer></methodparam>
16
15
<methodparam choice="opt"><type>string</type><parameter>escape</parameter><initializer>"\\"</initializer></methodparam>
17
16
</methodsynopsis>
...
...
@@ -21,7 +20,7 @@
21
20
<note>
22
21
<para>
23
22
The locale settings are taken into account by this function. If
24
-
<literal>LC_CTYPE</literal> is e.g. <literal>en_US.UTF-8</literal>, files in
23
+
<constant>LC_CTYPE</constant> is e.g. <literal>en_US.UTF-8</literal>, files in
25
24
one-byte encodings may be read wrongly by this function.
26
25
</para>
27
26
</note>
...
...
@@ -32,10 +31,10 @@
32
31
<para>
33
32
<variablelist>
34
33
<varlistentry>
35
-
<term><parameter>delimiter</parameter></term>
34
+
<term><parameter>separator</parameter></term>
36
35
<listitem>
37
36
<para>
38
-
The field delimiter (one character only). Defaults as a comma or the value set using <methodname>SplFileObject::setCsvControl</methodname>.
37
+
The field delimiter (one single-byte character only). Defaults as a comma or the value set using <methodname>SplFileObject::setCsvControl</methodname>.
39
38
</para>
40
39
</listitem>
41
40
</varlistentry>
...
...
@@ -43,7 +42,7 @@
43
42
<term><parameter>enclosure</parameter></term>
44
43
<listitem>
45
44
<para>
46
-
The field enclosure character (one character only). Defaults as a double quotation mark or the value set using <methodname>SplFileObject::setCsvControl</methodname>.
45
+
The field enclosure character (one single-byte character only). Defaults as a double quotation mark or the value set using <methodname>SplFileObject::setCsvControl</methodname>.
47
46
</para>
48
47
</listitem>
49
48
</varlistentry>
...
...
@@ -51,12 +50,12 @@
51
50
<term><parameter>escape</parameter></term>
52
51
<listitem>
53
52
<para>
54
-
The escape character (at most one character). Defaults as a backslash (<literal>\</literal>) or the value set using <methodname>SplFileObject::setCsvControl</methodname>.
53
+
The escape character (at most one single-byte character). Defaults as a backslash (<literal>\</literal>) or the value set using <methodname>SplFileObject::setCsvControl</methodname>.
55
54
An empty string (<literal>""</literal>) disables the proprietary escape mechanism.
56
55
</para>
57
56
<note>
58
57
<simpara>
59
-
Usually an <parameter>enclosure</parameter> character is escpaped inside
58
+
Usually an <parameter>enclosure</parameter> character is escaped inside
60
59
a field by doubling it; however, the <parameter>escape</parameter>
61
60
character can be used as an alternative. So for the default parameter
62
61
values <literal>""</literal> and <literal>\"</literal> have the same
...
...
@@ -180,7 +179,6 @@ A salmon is a fish with 0 legs
180
179
</refsect1>
181
180
182
181
</refentry>
183
-
184
182
<!-- Keep this comment at the end of the file
185
183
Local variables:
186
184
mode: sgml
187
185