Obtient une ligne depuis un pointeur de fichier et l'analyse pour des champs CSV

Description

fgetcsv(
    resource $stream,
    ?int $length = null,
    string $separator = ",",
    string $enclosure = "\"",
    string $escape = "\\"
): array|false

Similaire à fgets() mais fgetcsv() analyse la ligne qu'il lit et recherche les champs CSV, qu'il va retourner dans un tableau les contenant.

Note:
La définition des locales entre en jeu avec cette fonction. Si LC_CTYPE vaut, par exemple en_US.UTF-8, les fichiers encodés avec un encodage d'un octet peuvent être mal lus par cette fonction.

Liste de paramètres

stream

Un pointeur valide sur un fichier ouvert avec fopen(), popen() ou fsockopen().

length

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 length caractères, sauf si la scission se produit à l'intérieur d'un encadrement.

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.

separator

Le paramètre optionnel separator définit le séparateur de champ (un caractère d'un seul octet).

enclosure

Le paramètre optionnel enclosure définit le caractère d'encadrement de texte (un caractère d'un seul octet).

escape

Le paramètre optionnel escape définit le caractère d'échappement (au plus un caractère d'un seul octet). Une chaîne de caractères vide ("") désactive le mécanisme d'échappement propriétaire.

Note: En général un caractère d'encadrement enclosure est échappé à l'intérieur d'un champ en le dédoublant ; Cependant, le caractère d'échappement escape peut être utilisé comme une alternative. Donc pour la valeur par défaut "" et \" ont la même signification. Outre échapper le caractère d'encadrement enclosure le caractère d'échappement escape n'a pas de signification spéciale ; même pas de s'échapper lui-même.

Valeurs de retour

Retourne un tableau indexé contenant les champs lus en cas de succès, ou false si une erreur survient.

Note:
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.

Note: Si PHP ne reconnaît pas correctement les fins de lignes lors de la lecture de fichiers qui ont été créés ou lus sur un Macintosh, l'activation de l'option de configuration auto_detect_line_endings peut régler le problème.

Historique

Version	Description
8.0.0	`length` est désormais nullable.
7.4.0	Le paramètre `escape` accepte désormais une chaîne de caractère vide afin de désactiver le mécanisme d'échappement propriétaire.

Exemples

Exemple #1 Lit et affiche le contenu d'un fichier CSV


<?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);
}
?>

Voir aussi

str_getcsv() - Analyse une chaîne de caractères CSV dans un tableau
explode() - Scinde une chaîne de caractères en segments
file() - Lit le fichier et renvoie le résultat dans un tableau
pack() - Compacte des données dans une chaîne binaire
fputcsv() - Formate une ligne en CSV et l'écrit dans un fichier