(PHP 4, PHP 5, PHP 7, PHP 8)
fgetcsv — Читает строку из файла и производит разбор данных CSV
$stream
,$length
= null
,$separator
= ",",$enclosure
= "\"",$escape
= "\\"Данная функция похожа на функцию fgets(), с той разницей, что она производит анализ строки на наличие записей в формате CSV и возвращает найденные поля в качестве массива.
Замечание:
Эта функция принимает во внимание настройки локали. К примеру, если
LANG
установлена вen_US.UTF-8
, то файлы в однобайтовой кодировке будут неправильно прочитаны этой функцией.
stream
Корректный файловый указатель на файл, успешно открытый при помощи fopen(), popen() или fsockopen().
length
Должен быть больше самой длинной строки (в символах), найденной в CSV-файле
(включая завершающий символ конца строки). В противном случае, строка
будет разбита на куски длиной в length
символов,
если только место разрыва не будет внутри ограничителей полей (enclosure).
Отсутствие этого параметра (или установка его в 0 или null
, начиная с PHP 8.0.0) приведёт к
тому, что длина строки будет не ограничена. Это может сказаться на скорости выполнения.
separator
Необязательный параметр separator
устанавливает
разделитель поля (только один однобайтовый символ).
enclosure
Необязательный параметр enclosure
устанавливает
символ ограничителя поля (только один однобайтовый символ).
escape
Необязательный параметр escape
устанавливает
экранирующий символ (не более одного однобайтового символа).
Пустая строка (""
) отключает проприетарный механизм экранирования.
Замечание: Обычно символ
enclosure
экранируется внутри поля путём его удваивания; однако, символescape
в качестве альтернативы. Поэтому значения по умолчанию этих параметров""
и\"
имеют одинаковое значение. Помимо разрешения экранировать символenclosure
символescape
не имеет особого смысла; он даже не предназначен для самого экранирования.
Возвращает индексированный массив с прочтёнными полями в случае успешного выполнения или false
в случае возникновения ошибки.
Замечание:
Пустая строка CSV-файла будет возвращена в качестве массива, содержащего единственный элемент null, ошибки в данном случае не возникнет.
Замечание: Если у вас возникают проблемы с распознаванием PHP концов строк при чтении или создании файлов на Macintosh-совместимом компьютере, включение опции auto_detect_line_endings может помочь решить проблему.
Версия | Описание |
---|---|
8.0.0 |
Параметр length теперь допускает значение null .
|
7.4.0 |
Теперь параметр escape может принимать пустую строку для
отключения проприетарного механизма экранирования.
|
Пример #1 Чтение и вывод на экран содержимого CSV-файла
<?php
$row = 1;
if (($handle = fopen("test.csv", "r")) !== FALSE) {
while (($data = fgetcsv($handle, 1000, ",")) !== FALSE) {
$num = count($data);
echo "<p> $num полей в строке $row: <br /></p>\n";
$row++;
for ($c=0; $c < $num; $c++) {
echo $data[$c] . "<br />\n";
}
}
fclose($handle);
}
?>