(PHP 5 >= 5.1.0, PHP 7, PHP 8)
fputcsv — Formate une ligne en CSV et l'écrit dans un fichier
$stream
,$fields
,$separator
= ",",$enclosure
= "\"",$escape
= "\\",$eol
= "\n"
fputcsv() formate la ligne passée sous forme de
fields
tableau) en tant que CSV et l'écrit
(terminé par un eol
) dans le stream
spécifié.
stream
Le pointeur de fichier doit être valide et pointer sur un fichier ouvert avec succès par fopen() ou fsockopen() (et pas encore fermé par fclose()).
fields
Un tableau de chaînes de caractères string.
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.
eol
Le paramètre optionnel eol
définit une séquence
de fin de ligne (End of Line) personnalisé.
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.
Note:
Si un caractère
enclosure
est contenu dans un champ, il sera échappé en le doublant, à moins qu'il ne soit immédiatement précédé d'unescape
.
Retourne la taille de la chaîne écrite ou false
si une erreur survient.
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.1.0 |
Le paramètre optionnel eol a été ajouté.
|
7.4.0 |
Le paramètre escape accepte désormais une chaîne de
caractères vide afin de désactiver le mécanisme d'échapement propriétaire.
|
Exemple #1 Exemple avec fputcsv()
<?php
$list = [
['aaa', 'bbb', 'ccc', 'dddd'],
['123', '456', '789'],
['"aaa"', '"bbb"']
];
$fp = fopen('file.csv', 'w');
foreach ($list as $fields) {
fputcsv($fp, $fields, ',', '"', '');
}
fclose($fp);
?>
L'exemple ci-dessus va écrire ce qui suit vers file.csv
:
aaa,bbb,ccc,dddd 123,456,789 """aaa""","""bbb"""