fputcsv

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

fputcsvFormat line as CSV and write to file pointer

Опис

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

fputcsv() formats a line (passed as a fields array) as CSV and writes it (terminated by a newline) to the specified file stream.

Параметри

stream

Вказівник на файл має бути дійсним та має вказувати на файл, успішно відкритий функцією fopen() або fsockopen() (та не закритий функцією fclose()).

fields

An array of strings.

separator

The optional separator parameter sets the field delimiter (one single-byte character only).

enclosure

The optional enclosure parameter sets the field enclosure (one single-byte character only).

escape

The optional escape parameter sets the escape character (at most one single-byte character). An empty string ("") disables the proprietary escape mechanism.

eol

The optional eol parameter sets a custom End of Line sequence.

Увага

When escape is set to anything other than an empty string ("") it can result in CSV that is not compliant with » RFC 4180 or unable to survive a roundtrip through the PHP CSV functions. The default for escape is "\\" so it is recommended to set it to the empty string explicitly. The default value will change in a future version of PHP, no earlier than PHP 9.0.

Зауваження:

If an enclosure character is contained in a field, it will be escaped by doubling it, unless it is immediately preceded by an escape.

Значення, що повертаються

Returns the length of the written string або false в разі помилки.

Журнал змін

Версія Опис
8.1.0 The optional eol parameter has been added.
7.4.0 The escape parameter now also accepts an empty string to disable the proprietary escape mechanism.

Приклади

Приклад #1 fputcsv() example

<?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);
?>

The above example will write the following to file.csv:

aaa,bbb,ccc,dddd
123,456,789
"""aaa""","""bbb"""

Примітки

Зауваження: Якщо виникають проблеми з розпізнаванням закінчення рядків під час читання чи створення файлів на компʼютері Macintosh, може допомогти застосування директиви auto_detect_line_endings під час виконання.

Прогляньте також

  • fgetcsv() - Gets line from file pointer and parse for CSV fields