(PHP 5 >= 5.2.0, PHP 7, PHP 8)
SplFileObject::setCsvControl — Définit les options CSV
$separator = ",", string $enclosure = "\"", string $escape = "\\"): voidDéfinit le délimiteur, le caractère d'échappement ainsi que le caractère utilisé pour entourer les champs CSV analysés.
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.
Dans le flux d'entrée, le caractère d'encadrement enclosure
peut toujours être échappé en le doublant à l'intérieur d'une chaîne entre guillemets,
ce qui donne un seul caractère enclosure
dans le résultat analysé.
Le caractère d'échappement escape fonctionne différemment :
si une séquence de caractères escape et
enclosure apparaît dans l'entrée,
les deux caractères seront présents dans le résultat analysé.
Donc avec les paramètres par défaut, une ligne CSV comme
"a""b","c\"d" aura les champs analysés comme
a"b et c\"d, respectivement.
À 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.
Aucune valeur n'est retournée.
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ères vides afin de désactiver le mécanisme d'échappement propriétaire.
|
Exemple #1 Exemple avec SplFileObject::setCsvControl()
<?php
$file = new SplFileObject("data.csv");
$file->setFlags(SplFileObject::READ_CSV);
$file->setCsvControl('|');
foreach ($file as $row) {
list ($fruit, $quantity) = $row;
// Opération sur les données
}
?>Contenu de data.csv
<?php apples|20 bananas|14 cherries|87 ?>