SplFileObject::fgetcsv

(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

Description

Ré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:

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 avec un encodage d'un octet peuvent être mal lus par cette fonction.

Liste de paramètres

separator

Le délimiteur de champs (un caractère d'un seul octet). Par défaut, ce sera une virgule ou la valeur définie en utilisant la méthode splfileobject::setCsvControl().

enclosure

Le 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'échappement (au plus un caractère d'un seul octet). Par défaut, ce sera un antislash (\) ou bien la valeur définie en utilisant la méthode splfileobject::setCsvControl(). Une chaîne de caractères vide ("") désactive le mécanisme d'échappement propriétaire.

Note: Habituellement, un enclosure caractère est échappé à l'intérieur d'un champ en le doublant; Toutefois, le caractère escape peut ê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ère enclosure le caractère escape n'a pas de sens particulier; il n'est même pas destiné à s'échapper.

Valeurs de retour

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 null sauf si vous utilisez SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE, auquel cas, les lignes vides seront ignorées.

Historique

Exemples

Exemple #1 Exemple avec splfileobject::fgetcsv()

Exemple #2 Exemple avec SplFileObject::READ_CSV

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

Voir aussi

• splfileobject::setCsvControl() - Définit les options CSV
• SplFileObject::setFlags() - Définit les drapeaux pour l'objet SplFileObject
• SplFileObject::READ_CSV
• SplFileObject::current() - Récupère la ligne courante d'un fichier