(PHP 5 >= 5.1.0, PHP 7, PHP 8)
fputcsv — Формирует строку в CSV-формате и записывает строку в файловый указатель
$stream,$fields,$separator = ",",$enclosure = "\"",$escape = "\\",$eol = "\n"
Функция fputcsv() формирует из массива полей fields
строку в CSV-формате, завершает её символом перевода строки
и записывает строку в файловый указатель stream.
streamТребуется допустимый указатель на файл, который успешно открыли функцией fopen() или функцией fsockopen() и ещё не закрыли функцией fclose().
fieldsМассив строк (string).
separator
Параметр separator устанавливает
символ-разделитель полей и принимает только один однобайтовый символ.
enclosure
Параметр enclosure устанавливает
символ-ограничитель значения поля и принимает только один однобайтовый символ.
escape
Параметр escape устанавливает
символ экранирования и принимает только один однобайтовый символ или пустую строку.
Пустая строка "" отключает внутренний механизм экранирования.
Замечание: Обычно символ ограничителя значений —
enclosureэкранируется внутри поля путём удвоения; однако как альтернативу разрешается использовать символ экранированияescape. Поэтому для стандартных значений параметра смысл значений""и\"одинаков. Символ экранирования —escapeне несёт отдельного смысла, кроме экранирования символа ограничителя значений —enclosure; он даже не экранирует сам себя.
Начиная с PHP 8.4.0 полагаться на значение по умолчанию,
которое содержит параметр escape, не рекомендуют.
Значение потребуется указать явно, позиционно
или как именованный аргумент.
eol
Необязательный параметр eol устанавливает
пользовательскую последовательность конца строки.
Строка в CSV-формате иногда перестаёт соответствовать стандарту » RFC 4180
или не выдерживает обмена информацией с PHP-функциями
для работы с CSV-строками, если для символа экранирования escape устанавливают значение,
которое отличается от пустой строки "".
Значение по умолчанию для параметра escape — "\\",
поэтому рекомендуют явно указывать пустую строку. Значение по умолчанию изменят в будущей версии PHP, но не раньше PHP 9.0.
Замечание:
Функция заэкранирует символ ограничителя полей путём удвоения, если поле содержит символ ограничителя полей
enclosure, если только перед ограничителем, который функция встретила в поле, не идёт символ экранированияescape.
Функция возвращает длину строки, которую записала, или false, если возникла ошибка.
Функция выбрасывает ошибку ValueError,
если аргументы для разделителя полей separator или ограничителя значений enclosure
содержат значение короче одного байта.
Функция выбрасывает ошибку ValueError,
если длина значения аргумента escape не равна одному байту или передали пустую строку.
| Версия | Описание |
|---|---|
| 8.4.0 |
Вызов функции без явной передачи значения в параметр escape
устарел.
|
| 8.1.0 |
Добавили необязательный параметр eol.
|
| 7.4.0 |
Теперь параметр escape принимает пустую строку
для отключения внутреннего механизма экранирования.
|
Пример #1 Пример форматирования и записи CSV-строки в файл функцией fputcsv()
<?php
$list = [
['aaa', 'bbb', 'ccc', 'dddd'],
['123', '456', '789'],
['"aaa"', '"bbb"']
];
$fp = fopen('file.csv', 'w');
foreach ($list as $fields) {
fputcsv($fp, $fields, ',', '"', '');
}
fclose($fp);
?>
Пример запишет в файл file.csv следующие строки:
aaa,bbb,ccc,dddd 123,456,789 """aaa""","""bbb"""