SplFileObject::fgetcsv

(PHP 5 >= 5.1.0, PHP 7)

SplFileObject::fgetcsv — Obtiene una línea de un fichero y la analiza como campos CSV

Descripción

public SplFileObject::fgetcsv ([ string $delimiter = "," [, string $enclosure = "\"" [, string $escape = "\\" ]]] ) : array

Obtiene una línea del fichero la cual está en formato CSV y devuelve un array que contiene los campos leídos.

Parámetros

delimiter: El delimitador de campos (sólo un carácter). Por omisión, es una coma o el valor establecido por SplFileObject::setCsvControl().
enclosure: El carácter circundante de cada campo (sólo un carácter). Por omisión, son comillas dobles o el valor establecido por SplFileObject::setCsvControl().
escape: El carácter de escape (sólo un carácter). Por omisión, es una barra invertida (\) o el valor establecido por SplFileObject::setCsvControl().

Valores devueltos

Devuelve un array indexado que contiene los campos leídos, o FALSE en caso de error.

Nota:
Una línea en blanco en un fichero CSV será devuelta como un array constituido por un campo NULL a menos que se establezca SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE, en cuyo caso se omiten las líneas vacías.

Ejemplos

Ejemplo #1 Ejemplo de SplFileObject::fgetcsv()


<?php
$fichero = new SplFileObject("datos.csv");
while (!$fichero->eof()) {
    var_dump($fichero->fgetcsv());
}
?>

Ejemplo #2 Ejemplo de SplFileObject::READ_CSV


<?php
$fichero = new SplFileObject("animales.csv");
$fichero->setFlags(SplFileObject::READ_CSV);
foreach ($fichero as $fila) {
    list($animal, $clase, $patas) = $fila;
    printf("Un %s es un %s con %d patas\n", $animal, $clase, $patas);
}
?>

Contenido de animales.csv

cocodrilo,reptil,4
delfín,mamífero,0
pato,ave,2
koala,mamífero,4
salmón,pez,0

El resultado del ejemplo sería algo similar a:

Un cocodrilo es un reptil con 4 patas
Un delfín es un mamífero con 0 patas
Un pato es un ave con 2 patas
un koala es un mamífero con 4 patas
Un salmón es un pez con 0 patas

Ver también

SplFileObject::setCsvControl() - Establece el carácter delimitador y el circundante para campos CSV
SplFileObject::setFlags() - Establece flags para el SplFileObject
SplFileObject::READ_CSV
SplFileObject::current() - Recupera la línea actual del fichero

add a note

User Contributed Notes 4 notes

down

android991 at gmail dot com ¶

6 months ago


Be aware.
There is bug 46569 persists that breaks usage of SplFileObject::fgetcsv() after SplFileObject::seek()-ing to a non-zero position and then returns the contents of wrong line - off by one
<?php
$file = new SplFileObject('foo/bar.csv');
$file->seek(1);
print_r($file->fgetcsv()); // reads 3rd line against 2nd

down

vaughn dot clayton+php at servicetrade dot com ¶

6 years ago


Note that due to bugs 55807 and 61032, introduced in 5.3.8, if the csv in example #2 has a newline character at the end of each line, the foreach will execute 6 times.

The last time through the loop $row will be bool(false). This is true even if using SplFileObject::SKIP_EMPTY and SplFileObject::DROP_NEW_LINE.

Until the bug is fixed, the workaround is to also add SplFileObject::READ_AHEAD to your setFlags() call.

down

Denitz ¶

10 months ago


If your CSV doesn't have enclosures, you can face an issue with default " identified as enclosure in data. Empty $enclosure is not allowed, but you can use same $enclosure as $delimiter (\n by default) to emulate empty enclosure.

down

v-fpiris at teknober dot com ¶

8 years ago


after setting the delimiter '\t' fgetcsv() truncates the value when it is empty string 



workaround:



<?php

$file = new SplFileObject($path);

$file->setFlags(SplFileObject::DROP_NEW_LINE);

while ($file->valid()) {

    $line = $file->fgets();

    $line = explode("\t", $line);



    print_r($line);

}

?>

add a note