-
Notifications
You must be signed in to change notification settings - Fork 146
/
fgetcsv.xml
209 lines (202 loc) · 6.91 KB
/
fgetcsv.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
206
207
208
209
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 61374bbe228e8e9c55a24aba59a1e2bb2a871148 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.fgetcsv" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fgetcsv</refname>
<refpurpose>Obtient une ligne depuis un pointeur de fichier et l'analyse pour des champs CSV</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>fgetcsv</methodname>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></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>
</methodsynopsis>
<para>
Similaire à <function>fgets</function> mais <function>fgetcsv</function>
analyse la ligne qu'il lit et recherche les champs <acronym>CSV</acronym>,
qu'il va retourner dans un tableau les contenant.
</para>
<note>
<para>
La définition des locales entre en jeu avec cette fonction. Si
<constant>LC_CTYPE</constant> vaut, par exemple <literal>en_US.UTF-8</literal>,
les fichiers encodés avec un encodage d'un octet peuvent être mal lus par cette fonction.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
Un pointeur valide sur un fichier ouvert avec <function>fopen</function>,
<function>popen</function> ou <function>fsockopen</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
Doit être plus grand que la plus grande ligne (en terme de caractères)
à lire dans le fichier (y compris le caractère de fin de ligne).
Dans le cas contraire la ligne sera scindée en tranches de <parameter>length</parameter> caractères,
sauf si la scission se produit à l'intérieur d'un encadrement.
</para>
<para>
Omettre ce paramètre (ou le définir à 0, ou &null; en PHP 8.0.0 ou
ultérieur) fait que la longueur maximale de la ligne n'est pas limitée,
ce qui est légèrement plus lent.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>separator</parameter></term>
<listitem>
<para>
Le paramètre optionnel <parameter>separator</parameter> définit le séparateur de champ (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 d'encadrement de texte (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>
<note>
<simpara>
En général un caractère d'encadrement <parameter>enclosure</parameter> est
échappé à l'intérieur d'un champ en le dédoublant ;
Cependant, le caractère d'échappement <parameter>escape</parameter> peut être utilisé comme une alternative.
Donc pour la valeur par défaut <literal>""</literal> et <literal>\"</literal>
ont la même signification. Outre échapper le caractère d'encadrement <parameter>enclosure</parameter>
le caractère d'échappement <parameter>escape</parameter> n'a pas de
signification spéciale ; même pas de s'échapper lui-même.
</simpara>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne un tableau indexé contenant les champs lus en cas de succès, &return.falseforfailure;.
</para>
<note>
<para>
Une ligne vide dans un fichier CSV sera retournée sous la
forme d'un tableau contenant la valeur &null; et ne sera pas traitée
comme une erreur.
</para>
</note>
¬e.line-endings;
</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.0.0</entry>
<entry>
<parameter>length</parameter> est désormais nullable.
</entry>
</row>
<row>
<entry>7.4.0</entry>
<entry>
Le paramètre <parameter>escape</parameter> accepte désormais une chaîne de
caractère vide afin de désactiver le mécanisme d'échappement propriétaire.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Lit et affiche le contenu d'un fichier CSV</title>
<programlisting role="php">
<![CDATA[
<?php
$row = 1;
if (($handle = fopen("test.csv", "r")) !== FALSE) {
while (($data = fgetcsv($handle, 1000, ",")) !== FALSE) {
$num = count($data);
echo "<p> $num champs à la ligne $row: <br /></p>\n";
$row++;
for ($c=0; $c < $num; $c++) {
echo $data[$c] . "<br />\n";
}
}
fclose($handle);
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>str_getcsv</function></member>
<member><function>explode</function></member>
<member><function>file</function></member>
<member><function>pack</function></member>
<member><function>fputcsv</function></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
-->