(PHP 4, PHP 5, PHP 7)
fgetcsv — Obtient une ligne depuis un pointeur de fichier et l'analyse pour des champs CSV
$handle
[, int $length = 0
[, string $delimiter = ","
[, string $enclosure = '"'
[, string $escape = "\\"
]]]] ) : arraySimilaire à 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 par un encodage d'un octet peuvent être mal lus par cette function.
handleUn 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 en PHP 5.1.0 et suivant) fait que la longueur maximale de la ligne n'est pas limitée, ce qui est légèrement plus lent.
delimiter
Le paramètre optionnel delimiter définit le séparateur de champ (un seul caractère).
enclosure
Le paramètre optionnel enclosure définit le caractère d'encadrement de texte (un seul caractère).
escape
Le paramètre optionnel escape définit le caractère d'échappement (au plus un caractère).
Une chaîne de caractères vide ("") désactive le mécanisme d'échappement propriétaire.
Note: En général un charactère d'encadrement
enclosureest échappé à l'intérieur d'un champ en le dédoublant; Cependant, le caractère d'échappementescapepeut être utilisé comme une alternative. Donc pour la valeur par défaut "" et \" ont la même signification. Outre échapper le charactère d'encadrementenclosurele caractère d'échappementescapen'a pas de signification spéciale; même pas de s'échapper lui-même.
Retourne un tableau indexé contenant les champs lus.
Note:
Une ligne vide dans un fichier CSV sera retournée sous la forme d'un tableau contenant la valeur
NULLet 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.
fgetcsv() retourne NULL si un paramètre
handle invalide est fourni ou FALSE
en cas d'autres erreurs, y compris la fin du fichier.
| Version | Description |
|---|---|
| 7.4.0 |
Le paramètre escape accepte désormais une chaîne de
charactère vide afin de désactiver le mécanisme d'échapement propriétaire.
|
| 5.3.0 |
Le paramètre escape a été ajouté.
|
| 5.1.0 |
Le paramètre length est maintenant optionnel.
Par défaut, vaut 0, ce qui signifie qu'il n'y a
aucune limite de longueur.
|
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);
}
?>