SplFileObject::fgetcsv

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

SplFileObject::fgetcsv — Получить строку из файла и её разбор как поля CSV

Описание

public SplFileObject::fgetcsv(string $separator = ",", string $enclosure = "\"", string $escape = "\\"): array|false

Получает строку из файла и разбирает её в соответствии с форматом CSV. Результаты разбора возвращает в виде массива.

Замечание:
Эта функция принимает во внимание настройки локали. К примеру, если LC_CTYPE установлена в en_US.UTF-8, то файлы в однобайтовой кодировке будут неправильно прочитаны этой функцией.

Список параметров

separator: Разделитель полей (только один однобайтовый символ). По умолчанию это запятая или символ, который был задан методом SplFileObject::setCsvControl().
enclosure: Символ ограничителя полей (только один однобайтовый символ). По умолчанию это двойная кавычка или символ, который был задан методом SplFileObject::setCsvControl(). Пустая строка ("") отключает проприетарный механизм экранирования.

Замечание: Обычно символ enclosure экранируется внутри поля путём его удваивания; однако, символ escape в качестве альтернативы. Поэтому значения по умолчанию этих параметров "" и \" имеют одинаковое значение. Помимо разрешения экранировать символ enclosure символ escape не имеет особого смысла; он даже не предназначен для самого экранирования.
escape: Экранирующий символ (не более одного однобайтового символа). По умолчанию это обратный слеш (\) или символ, который был задан методом SplFileObject::setCsvControl().

Возвращаемые значения

Возвращает массив содержащий данные прочитанной строки или false в случае ошибки.

Замечание:
Пустая строка CSV-файла будет возвращаться в виде массива, содержащего единственный элемент null, если не используется SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE, и в этом случае пустые строки пропускаются.

Список изменений

Версия	Описание
7.4.0	Теперь параметр `escape` может принимать пустую строку для отключения проприетарного механизма экранирования.

Примеры

Пример #1 Пример использования SplFileObject::fgetcsv()

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

Пример #2 Пример использования SplFileObject::READ_CSV

<?php
$file = new SplFileObject("animals.csv");
$file->setFlags(SplFileObject::READ_CSV);
foreach ($file as $row) {
    list($animal, $class, $legs) = $row;
    printf("A %s is a %s with %d legs\n", $animal, $class, $legs);
}
?>

Contents of animals.csv

crocodile,reptile,4
dolphin,mammal,0
duck,bird,2
koala,mammal,4
salmon,fish,0

Вывод приведённого примера будет похож на:

A crocodile is a reptile with 4 legs
A dolphin is a mammal with 0 legs
A duck is a bird with 2 legs
A koala is a mammal with 4 legs
A salmon is a fish with 0 legs

Смотрите также

SplFileObject::setCsvControl() - Устанавливает символы разделителя, обёртывания и экранирования для CSV
SplFileObject::setFlags() - Устанавливает флаги для SplFileObject
SplFileObject::READ_CSV
SplFileObject::current() - Получить текущую строки файла

add a note

User Contributed Notes 6 notes

down

android991 at gmail dot com ¶

5 years 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

v-fpiris at teknober dot com ¶

12 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);

}

?>

down

Denitz ¶

5 years 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

vaughn dot clayton+php at servicetrade dot com ¶

11 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

InvisibleSmiley ¶

2 years ago


Not that this may return NULL instead of FALSE depending on the given SplFileObject flags in versions prior to PHP 8.1.

Change: https://github.com/php/php-src/commit/188b1d4c7c7b3482584e248522d94e06ba616a1c

Testcase: https://3v4l.org/6dQTT

down

jbrauer ¶

4 years ago


Also while the enclosure character cannot be NULL you can set it to ASCII NUL character chr(0) with the same practical effect.

add a note