mirror of
https://github.com/php/doc-fr.git
synced 2026-03-24 07:02:06 +01:00
257 lines
8.7 KiB
XML
257 lines
8.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: 0a3648a71895f35f570573d31ca9e003786aa993 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>
|
|
<simpara>
|
|
Les paramètres de locale sont pris en compte par cette fonction.
|
|
Par exemple, les données encodées dans certains encodages à un octet peuvent être analysées
|
|
incorrectement si <constant>LC_CTYPE</constant> est
|
|
<literal>en_US.UTF-8</literal>.
|
|
</simpara>
|
|
</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 termes 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 <parameter>separator</parameter> définit le séparateur de champ.
|
|
Il doit s'agir d'un caractère d'un seul octet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>enclosure</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Le paramètre <parameter>enclosure</parameter> définit le caractère d'encadrement des champs.
|
|
Il doit s'agir d'un caractère d'un seul octet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>escape</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Le paramètre <parameter>escape</parameter> définit le caractère d'échappement.
|
|
Il doit s'agir d'un caractère d'un seul octet ou d'une chaîne vide.
|
|
La chaîne vide (<literal>""</literal>) désactive le mécanisme d'échappement propriétaire.
|
|
</para>
|
|
<warning xml:id="function.fgetcsv..warn.escape.parameter">
|
|
<simpara>
|
|
Dans le flux d'entrée, le caractère d'encadrement <parameter>enclosure</parameter>
|
|
peut toujours être échappé en le doublant à l'intérieur d'une chaîne entre guillemets,
|
|
ce qui donne un seul caractère <parameter>enclosure</parameter>
|
|
dans le résultat analysé.
|
|
Le caractère d'échappement <parameter>escape</parameter> fonctionne différemment :
|
|
si une séquence de caractères <parameter>escape</parameter> et
|
|
<parameter>enclosure</parameter> apparaît dans l'entrée,
|
|
les deux caractères seront présents dans le résultat analysé.
|
|
Donc avec les paramètres par défaut, une ligne CSV comme
|
|
<literal>"a""b","c\"d"</literal> aura les champs analysés comme
|
|
<literal>a"b</literal> et <literal>c\"d</literal>, respectivement.
|
|
</simpara>
|
|
</warning>
|
|
<warning>
|
|
<simpara>
|
|
À partir de PHP 8.4.0, l'utilisation de la valeur par défaut de
|
|
<parameter>escape</parameter> est dépréciée.
|
|
Elle doit être fournie explicitement soit par position, soit par l'utilisation
|
|
des <link linkend="functions.named-arguments">arguments nommés</link>.
|
|
</simpara>
|
|
</warning>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
&warning.csv.escape-parameter;
|
|
</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 est 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="errors">
|
|
&reftitle.errors;
|
|
<simpara>
|
|
Lève une <exceptionname>ValueError</exceptionname> si
|
|
<parameter>separator</parameter> ou <parameter>enclosure</parameter>
|
|
n'a pas une longueur d'un octet.
|
|
</simpara>
|
|
<simpara>
|
|
Lève une <exceptionname>ValueError</exceptionname> si
|
|
<parameter>escape</parameter> n'a pas une longueur d'un octet ou est une chaîne vide.
|
|
</simpara>
|
|
</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.4.0</entry>
|
|
<entry>
|
|
Se fier à la valeur par défaut de <parameter>escape</parameter> est désormais
|
|
déprécié.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>8.3.0</entry>
|
|
<entry>
|
|
Une chaîne vide est renvoyée au lieu d'une chaîne contenant un seul
|
|
octet nul pour le dernier champ si celui-ci contient uniquement une
|
|
délimitation non terminée.
|
|
</entry>
|
|
</row>
|
|
<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ères 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;
|
|
<simplelist>
|
|
<member><function>fputcsv</function></member>
|
|
<member><function>str_getcsv</function></member>
|
|
<member><methodname>SplFileObject::fgetcsv</methodname></member>
|
|
<member><methodname>SplFileObject::fputcsv</methodname></member>
|
|
<member><methodname>SplFileObject::setCsvControl</methodname></member>
|
|
<member><methodname>SplFileObject::getCsvControl</methodname></member>
|
|
<member><function>explode</function></member>
|
|
<member><function>file</function></member>
|
|
<member><function>pack</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|