-
Notifications
You must be signed in to change notification settings - Fork 146
/
fputcsv.xml
205 lines (191 loc) · 5.79 KB
/
fputcsv.xml
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="splfileobject.fputcsv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SplFileObject::fputcsv</refname>
<refpurpose>Écrit un tableau sous la forme d'une ligne CSV</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SplFileObject">
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>SplFileObject::fputcsv</methodname>
<methodparam><type>array</type><parameter>fields</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>","</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>enclosure</parameter><initializer>"\""</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>escape</parameter><initializer>"\\"</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>eol</parameter><initializer>"\n"</initializer></methodparam>
</methodsynopsis>
<para>
Écrit un tableau <parameter>fields</parameter> sous la forme d'une ligne CSV.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>fields</parameter></term>
<listitem>
<para>
Un tableau de valeurs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>separator</parameter></term>
<listitem>
<para>
Le paramètre optionnel <parameter>delimiter</parameter> définit le
délimiteur de champs (un caractère d'un seul octet).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>enclosure</parameter></term>
<listitem>
<para>
Le paramètre optionnel <parameter>enclosure</parameter> définit
le caractère entourant le champ (un caractère d'un seul octet).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>escape</parameter></term>
<listitem>
<para>
Le paramètre optionnel <parameter>escape</parameter>
définit le caractère d'échappement (au plus un caractère d'un seul octet).
Une &string; vide (<literal>""</literal>) désactive le mécanisme d'échappement propriétaire.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>eol</parameter></term>
<listitem>
<para>
Le paramètre optionnel <parameter>eol</parameter> définit une séquence
de fin de ligne (End of Line) personnalisé.
</para>
</listitem>
</varlistentry>
</variablelist>
<note>
<para>
Si un caractère <parameter>enclosure</parameter> est contenu dans un champ,
il sera échappé en le doublant, à moins qu'il ne soit immédiatement précédé
d'un <parameter>escape</parameter>.
</para>
</note>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne la longueur de la chaîne écrite&return.falseforfailure;.
</para>
<para>
Retourne &false;, et n'écrit pas la ligne CSV dans le fichier si
le paramètre <parameter>delimiter</parameter> ou le paramètre
<parameter>enclosure</parameter> n'est pas un caractère unique.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Une erreur de niveau <constant>E_WARNING</constant> est émise si
<parameter>separator</parameter> ou <parameter>enclosure</parameter>
n'est pas un seul caractère.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.1.0</entry>
<entry>
Le paramètre optionnel <parameter>eol</parameter> a été ajouté.
</entry>
</row>
<row>
<entry>7.4.0</entry>
<entry>
Le paramètre <parameter>escape</parameter> accepte désormais une chaîne de
caractères vide afin de désactivé le mécanisme d'échapement propriétaire.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example xml:id="splfileobject.fputcsv.examples.basic">
<title>Exemple avec <methodname>SplFileObject::fputcsv</methodname></title>
<programlisting role="php">
<![CDATA[
<?php
$list = array (
array('aaa', 'bbb', 'ccc', 'dddd'),
array('123', '456', '789'),
array('"aaa"', '"bbb"')
);
$file = new SplFileObject('file.csv', 'w');
foreach ($list as $fields) {
$file->fputcsv($fields);
}
?>
]]>
</programlisting>
<para>
L'exemple suivant va écrire la ligne suivante dans le fichier
<literal>file.csv</literal> :</para>
<screen>
<![CDATA[
aaa,bbb,ccc,dddd
123,456,789
"""aaa""","""bbb"""
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fputcsv</function></member>
<member><methodname>SplFileObject::fgetcsv</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->