(PHP 5 >= 5.1.0, PHP 7, PHP 8)
SplFileObject::fgetcsv — Получает строку из указателя файла и анализирует её на CSV-поля
$separator = ",", string $enclosure = "\"", string $escape = "\\"): array|falseМетод получает строку из CSV-файла и возвращает массив с прочитанными полями.
Замечание:
Метод учитывает настройки локали. Если для константы
LC_CTYPEустановили значение, например,en_US.UTF-8, метод может неправильно прочитать файлы в однобайтовой кодировке.
separatorРазделитель полей (только один однобайтовый символ). По умолчанию это запятая или символ, который задали методом SplFileObject::setCsvControl().
enclosureСимвол ограничителя полей (только один однобайтовый символ). По умолчанию это двойные кавычки или значение, которое установили методом SplFileObject::setCsvControl().
escape
Экранирующий символ (не более одного однобайтового символа). По умолчанию это обратный слеш
(\) или значение, которое установили методом
SplFileObject::setCsvControl().
Пустая строка ("") отключает собственный механизм экранирования.
Замечание: Обычно символ
enclosureэкранируется внутри поля путём удваивания; однако, символescapeразрешается использовать как альтернативу. Поэтому у значений по умолчанию для этих параметров""и\"одинаковые значения. Кроме разрешения экранировать символenclosureсимволescapeне имеет особого значения; он даже не экранирует самого себя.
Строка в CSV-формате иногда перестаёт соответствовать стандарту » RFC 4180
или не выдерживает обмена информацией с PHP-функциями
для работы с CSV-строками, если для символа экранирования escape устанавливают значение,
которое отличается от пустой строки "".
Значение по умолчанию для параметра escape — "\\",
поэтому рекомендуют явно указывать пустую строку. Значение по умолчанию изменят в будущей версии PHP, но не раньше PHP 9.0.
Метод возвращает массив, который содержит данные прочитанной строки, или 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
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 2ndafter 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);
}
?>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.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.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