fputcsv

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

fputcsvФормирует строку в CSV-формате и записывает строку в файловый указатель

Описание

fputcsv(
    resource $stream,
    array $fields,
    string $separator = ",",
    string $enclosure = "\"",
    string $escape = "\\",
    string $eol = "\n"
): int|false

Функция fputcsv() формирует строку в CSV-формате из массива полей fields и записывает строку, которая завершается переводом строки, в файл stream.

Список параметров

stream

Требуется допустимый файловый указатель, который указывает на файл, который успешно открыли функцией fopen() или функцией fsockopen(), и ещё не закрыли функцией fclose().

fields

Массив строк (string).

separator

Необязательный параметр separator устанавливает разделитель полей. Параметр принимает только один однобайтовый символ.

enclosure

Необязательный параметр enclosure устанавливает ограничитель полей. Параметр принимает только один однобайтовый символ.

escape

Необязательный параметр escape устанавливает символ экранирования. Параметр принимает не больше одного однобайтового символа. Пустая строка "" отключает внутренний механизм экранирования.

eol

Необязательный параметр eol устанавливает пользовательскую последовательность конца строки.

Внимание

Строка в CSV-формате иногда перестаёт соответствовать стандарту » RFC 4180 или не выдерживает обмена информацией с PHP-функциями для работы с CSV-строками, если для символа экранирования escape устанавливают значение, которое отличается от пустой строки "". Значение по умолчанию для параметра escape"\\", поэтому рекомендуют явно указывать пустую строку. Значение по умолчанию изменят в будущей версии PHP, но не раньше PHP 9.0.

Замечание:

Функция заэкранирует символ ограничителя полей путём удвоения, если поле содержит символ ограничителя полей enclosure, если только перед ограничителем, который функция встретила в поле, не идёт символ экранирования escape.

Возвращаемые значения

Функция возвращает длину строки, которую записала, или false, если возникла ошибка.

Список изменений

Версия Описание
8.1.0 Добавили необязательный параметр eol.
7.4.0 Теперь параметр escape принимает пустую строку для отключения внутреннего механизма экранирования.

Примеры

Пример #1 Пример форматирования и записи CSV-строки в файл функцией fputcsv()

<?php

$list
= array (
array(
'aaa', 'bbb', 'ccc', 'dddd'),
array(
'123', '456', '789'),
array(
'"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"""

Примечания

Замечание: Включение опции auto_detect_line_endings во время выполнения иногда помогает исправить неправильное распознавание языком PHP концов строк при чтении файлов на Macintosh-совместимом компьютере или файлов, которые создали на Макинтоше.

Смотрите также

  • fgetcsv() - Получает строку из указателя файла и разбирает поля CSV-файла