PHP 7.4.24 Released!

SplFileObject::fgetcsv

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

SplFileObject::fgetcsvRécupère une ligne depuis le fichier et l'analyse comme étant des données CSV

Description

public SplFileObject::fgetcsv(string $separator = ",", string $enclosure = "\"", string $escape = "\\"): array|false

Récupère une ligne depuis le fichier et l'analyse comme étant des données CSV et retourne un tableau contenant tous les champs lus.

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 par un encodage d'un octet peuvent être mal lus par cette fonction.

Liste de paramètres

separator

Le délimiteur de champs (un caractère d'un seul octet). Par défaut, ce sera une virgule ou la valeur définie en utilisant la méthode SplFileObject::setCsvControl().

enclosure

Le caractère utilisé pour entourer la valeur d'un champ (un caractère d'un seul octet). Par défaut, ce sera un guillemet double ou bien la valeur définie en utilisant la méthode SplFileObject::setCsvControl().

escape

Le caractère d'échappement (au plus un caractère d'un seul octet). Par défaut, ce sera un anti-slash (\) ou bien la valeur définie en utilisant la méthode SplFileObject::setCsvControl(). Une chaîne de caractères vide ("") désactive le mécanisme d'échappement propriétaire.

Note: Habituellement, un enclosure caractère est échappé à l'intérieur d'un champ en le doublant; Toutefois, le caractère escape peut être utilisé comme une alternative. Ainsi, pour les valeurs de paramètre par défaut "" et \" ont la même signification. Autre que de permettre d'échapper le caractère enclosure le caractère escape n'a pas de sens particulier; il n'est même pas destiné à s'échapper.

Valeurs de retour

Retourne un tableau indexé contenant tous les champs lus, ou false si une erreur survient.

Note:

Une ligne vide d'un fichier CSV sera retourné sous la forme d'un tableau contenu un seul champ null sauf si vous utilisez SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE, auquel cas, les lignes vides seront ignorées.

Historique

Version Description
7.4.0 Le paramètre escape accepte désormais une chaîne de caractère vide afin de désactivé le mécanisme d'échapement propriétaire.

Exemples

Exemple #1 Exemple avec SplFileObject::fgetcsv()

<?php
$file 
= new SplFileObject("data.csv");
while (!
$file->eof()) {
    
var_dump($file->fgetcsv());
}
?>

Exemple #2 Exemple avec SplFileObject::READ_CSV

<?php
$file 
= new SplFileObject("animals.csv");
$file->setFlags(SplFileObject::READ_CSV);
foreach (
$file as $row) {
    list(
$animal$class$legs) = $row;
    
printf("Un %s est un %s avec %d jambes\n"$animal$class$legs);
}
?>

Contenu de animals.csv

crocodile,reptile,4
dauphin,mammifère,0
canard,oiseau,2
koala,mammifère,4
saumon,poisson,0

Résultat de l'exemple ci-dessus est similaire à :

Un crocodile est un reptile avec 4 jambes
Un dauphin est un mammifère avec 0 jambes
Un canard est un oiseau avec 2 jambes
Un koala est un mammifère avec 4 jambes
Un saumon est un poisson avec 0 jambes

Voir aussi

add a note add a note

User Contributed Notes 5 notes

up
9
android991 at gmail dot com
2 years ago
Be aware.
There is bug 46569 persists that breaks usage of SplFileObject::fgetcsv() after SplFileObject::seek()-ing to a non-zero position and then returns the contents of wrong line - off by one
<?php
$file
= new SplFileObject('foo/bar.csv');
$file->seek(1);
print_r($file->fgetcsv()); // reads 3rd line against 2nd
up
2
v-fpiris at teknober dot com
10 years ago
after setting the delimiter '\t' fgetcsv() truncates the value when it is empty string

workaround:

<?php
$file
= new SplFileObject($path);
$file->setFlags(SplFileObject::DROP_NEW_LINE);
while (
$file->valid()) {
   
$line = $file->fgets();
   
$line = explode("\t", $line);

   
print_r($line);
}
?>
up
1
Denitz
3 years ago
If your CSV doesn't have enclosures, you can face an issue with default " identified as enclosure in data. Empty $enclosure is not allowed, but you can use same $enclosure as $delimiter (\n by default) to emulate empty enclosure.
up
1
vaughn dot clayton+php at servicetrade dot com
8 years ago
Note that due to bugs 55807 and 61032, introduced in 5.3.8, if the csv in example #2 has a newline character at the end of each line, the foreach will execute 6 times.

The last time through the loop $row will be bool(false). This is true even if using SplFileObject::SKIP_EMPTY and SplFileObject::DROP_NEW_LINE.

Until the bug is fixed, the workaround is to also add SplFileObject::READ_AHEAD to your setFlags() call.
up
0
jbrauer
1 year ago
Also while the enclosure character cannot be NULL you can set it to ASCII NUL character chr(0) with the same practical effect.
To Top