(PHP 4, PHP 5, PHP 7, PHP 8)
fgetcsv — Obtient une ligne depuis un pointeur de fichier et l'analyse pour des champs CSV
$stream
,$length
= null
,$separator
= ",",$enclosure
= "\"",$escape
= "\\"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: 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_CTYPE
esten_US.UTF-8
.
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 separator
définit le séparateur de champ.
Il doit s'agir d'un caractère d'un seul octet.
enclosure
Le paramètre enclosure
définit le caractère d'encadrement des champs.
Il doit s'agir d'un caractère d'un seul octet.
escape
Le paramètre escape
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 (""
) 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'échappementescape
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'encadrementenclosure
le caractère d'échappementescape
n'a pas de signification spéciale ; même pas de s'échapper lui-même.
À partir de PHP 8.4.0, l'utilisation de la valeur par défaut de
escape
est dépréciée.
Elle doit être fournie explicitement soit par position, soit par l'utilisation
des arguments nommés.
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 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.
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é.
|
8.3.0 | 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. |
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.
|
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);
}
?>