(PHP 5 >= 5.1.0, PHP 7, PHP 8)
SplFileObject::fgetcsv — Récupère une ligne depuis le fichier et l'analyse comme étant des données CSV
$separator = ",", string $enclosure = "\"", string $escape = "\\"): array|falseRé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: 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
LC_CTYPEesten_US.UTF-8.
separator
Le délimiteur de champ (un seul caractère sur un octet).
Par défaut, , ou la valeur définie par un appel précédent à
SplFileObject::setCsvControl().
enclosureLe 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'encadrement de champ (un seul caractère sur un octet).
Par défaut, " ou la valeur définie par un appel précédent à
SplFileObject::setCsvControl().
Une chaîne de caractères vide ("") désactive le mécanisme d'échappement propriétaire.
Note: Habituellement, un
enclosurecaractère est échappé à l'intérieur d'un champ en le doublant; Toutefois, le caractèreescapepeut ê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èreenclosurele caractèreescapen'a pas de sens particulier; il n'est même pas destiné à s'échapper.
À partir de PHP 8.4.0, dépendre de la valeur par défaut de
escape est obsolète.
Elle doit être fournie explicitement soit par position, soit par l'utilisation
des arguments nommés,
ou par un appel à SplFileObject::setCsvControl().
Lorsque le escape est défini sur autre chose qu'une chaîne vide
(""), cela peut entraîner un CSV qui n'est pas conforme à
» RFC 4180 ou incapable de survivre à un aller-retour
à travers les fonctions CSV de PHP. La valeur par défaut pour escape est
"\\", il est donc recommandé de la définir explicitement sur une chaîne vide.
La valeur par défaut changera dans une future version de PHP, au plus tôt dans PHP 9.0.
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
nullsauf si vous utilisezSplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE, auquel cas, les lignes vides seront ignorées.
Lève une ValueError si
separator ou enclosure
n'a pas une longueur de un octet.
Lève une ValueError si
escape n'a pas une longueur de un octet ou est une chaîne vide.
| Version | Description |
|---|---|
| 8.4.0 |
Se fier à la valeur par défaut de escape est désormais
déprécié.
|
| 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.
|
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
SplFileObject::READ_CSVBe 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 2ndafter 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);
}
?>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.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.Not that this may return NULL instead of FALSE depending on the given SplFileObject flags in versions prior to PHP 8.1.
Change: https://github.com/php/php-src/commit/188b1d4c7c7b3482584e248522d94e06ba616a1c
Testcase: https://3v4l.org/6dQTT