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
SplFileObject::fgetcsv
(PHP 5 >= 5.1.0, PHP 7, PHP 8)
SplFileObject::fgetcsv — Получить строку из файла и её разбор как поля CSV
Описание
public SplFileObject::fgetcsv(string
$delimiter = ",", string $enclosure = "\"", string $escape = "\\"): arrayПолучает строку из файла и разбирает её в соответствии с форматом CSV. Результаты разбора возвращает в виде массива.
Замечание:
Эта функция принимает во внимание настройки локали. К примеру, если
LC_CTYPEустановлена вen_US.UTF-8, то файлы в однобайтовой кодировке будут неправильно прочитаны этой функцией.
Список параметров
-
delimiter -
Разделитель полей (только один символ). По умолчанию это запятая или символ, который был задан методом 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 5 notes
android991 at gmail dot com ¶
5 years ago
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.
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);
}
?>
