reference/filesystem/functions/fputcsv.xml
291d60430d25f2b508bebb5720b41cc68f9a6ec1
291d60430d25f2b508bebb5720b41cc68f9a6ec1
...
...
@@ -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.fputcsv">
3
+
<refentry xml:id="function.fputcsv" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>fputcsv</refname>
6
6
<refpurpose>Format line as CSV and write to file pointer</refpurpose>
...
...
@@ -9,17 +9,18 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>int</type><methodname>fputcsv</methodname>
13
-
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
12
+
<type class="union"><type>int</type><type>false</type></type><methodname>fputcsv</methodname>
13
+
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
14
14
<methodparam><type>array</type><parameter>fields</parameter></methodparam>
15
-
<methodparam choice="opt"><type>string</type><parameter>delimiter</parameter><initializer>","</initializer></methodparam>
16
-
<methodparam choice="opt"><type>string</type><parameter>enclosure</parameter><initializer>'"'</initializer></methodparam>
17
-
<methodparam choice="opt"><type>string</type><parameter>escape_char</parameter><initializer>"\"</initializer></methodparam>
15
+
<methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>","</initializer></methodparam>
16
+
<methodparam choice="opt"><type>string</type><parameter>enclosure</parameter><initializer>"\""</initializer></methodparam>
17
+
<methodparam choice="opt"><type>string</type><parameter>escape</parameter><initializer>"\\"</initializer></methodparam>
18
+
<methodparam choice="opt"><type>string</type><parameter>eol</parameter><initializer>"\n"</initializer></methodparam>
18
19
</methodsynopsis>
19
20
<para>
20
21
<function>fputcsv</function> formats a line (passed as a
21
-
<parameter>fields</parameter> array) as CSV and write it (terminated by a
22
-
newline) to the specified file <parameter>handle</parameter>.
22
+
<parameter>fields</parameter> array) as CSV and writes it (terminated by a
23
+
newline) to the specified file <parameter>stream</parameter>.
23
24
</para>
24
25
</refsect1>
25
26
...
...
@@ -28,7 +29,7 @@
28
29
<para>
29
30
<variablelist>
30
31
<varlistentry>
31
-
<term><parameter>handle</parameter></term>
32
+
<term><parameter>stream</parameter></term>
32
33
<listitem>
33
34
&fs.validfp.all;
34
35
</listitem>
...
...
@@ -37,16 +38,16 @@
37
38
<term><parameter>fields</parameter></term>
38
39
<listitem>
39
40
<para>
40
-
An array of values.
41
+
An array of <type>string</type>s.
41
42
</para>
42
43
</listitem>
43
44
</varlistentry>
44
45
<varlistentry>
45
-
<term><parameter>delimiter</parameter></term>
46
+
<term><parameter>separator</parameter></term>
46
47
<listitem>
47
48
<para>
48
-
The optional <parameter>delimiter</parameter> parameter sets the field
49
-
delimiter (one character only).
49
+
The optional <parameter>separator</parameter> parameter sets the field
50
+
delimiter (one single-byte character only).
50
51
</para>
51
52
</listitem>
52
53
</varlistentry>
...
...
@@ -55,27 +56,44 @@
55
56
<listitem>
56
57
<para>
57
58
The optional <parameter>enclosure</parameter> parameter sets the field
58
-
enclosure (one character only).
59
+
enclosure (one single-byte character only).
59
60
</para>
60
61
</listitem>
61
62
</varlistentry>
62
63
<varlistentry>
63
-
<term><parameter>escape_char</parameter></term>
64
+
<term><parameter>escape</parameter></term>
64
65
<listitem>
65
66
<para>
66
-
The optional <parameter>escape_char</parameter> parameter sets the
67
-
escape character (one character only).
67
+
The optional <parameter>escape</parameter> parameter sets the
68
+
escape character (at most one single-byte character).
69
+
An empty string (<literal>""</literal>) disables the proprietary escape mechanism.
70
+
</para>
71
+
</listitem>
72
+
</varlistentry>
73
+
<varlistentry>
74
+
<term><parameter>eol</parameter></term>
75
+
<listitem>
76
+
<para>
77
+
The optional <parameter>eol</parameter> parameter sets
78
+
a custom End of Line sequence.
68
79
</para>
69
80
</listitem>
70
81
</varlistentry>
71
82
</variablelist>
72
83
</para>
84
+
<note>
85
+
<para>
86
+
If an <parameter>enclosure</parameter> character is contained in a field,
87
+
it will be escaped by doubling it, unless it is immediately preceded by an
88
+
<parameter>escape</parameter>.
89
+
</para>
90
+
</note>
73
91
</refsect1>
74
92
75
93
<refsect1 role="returnvalues">
76
94
&reftitle.returnvalues;
77
95
<para>
78
-
Returns the length of the written string&return.falseforfailure;.
96
+
Returns the length of the written string &return.falseforfailure;.
79
97
</para>
80
98
</refsect1>
81
99
...
...
@@ -92,9 +110,16 @@
92
110
</thead>
93
111
<tbody>
94
112
<row>
95
-
<entry>5.5.4</entry>
113
+
<entry>8.1.0</entry>
96
114
<entry>
97
-
The <parameter>escape_char</parameter> parameter was added
115
+
The optional <parameter>eol</parameter> parameter has been added.
116
+
</entry>
117
+
</row>
118
+
<row>
119
+
<entry>7.4.0</entry>
120
+
<entry>
121
+
The <parameter>escape</parameter> parameter now also accepts an empty
122
+
string to disable the proprietary escape mechanism.
98
123
</entry>
99
124
</row>
100
125
</tbody>
...
...
@@ -156,7 +181,6 @@ aaa,bbb,ccc,dddd
156
181
</refsect1>
157
182
158
183
</refentry>
159
-
160
184
<!-- Keep this comment at the end of the file
161
185
Local variables:
162
186
mode: sgml
163
187