(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().
Пустая строка (""
) отключает проприетарный механизм экранирования.
Замечание: Обычно символ
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