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 eol) to the specified stream.

Параметри

stream

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

fields

An array of strings.

separator

The separator parameter sets the field separator. It must be a single byte character.

enclosure

The enclosure parameter sets the field enclosure character. It must be a single byte character.

escape

The escape parameter sets the escape character. It must be a single byte character or the empty string. The empty string ("") disables the proprietary escape mechanism.

Зауваження: Usually an enclosure character is escaped inside a field by doubling it; however, the escape character can be used as an alternative. So for the default parameter values "" and \" have the same meaning. Other than allowing to escape the enclosure character the escape character has no special meaning; it isn't even meant to escape itself.

Увага

As of PHP 8.4.0, depending on the default value of escape is deprecated. It needs to be provided explicitly either positionally or by the use of named arguments.

eol

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

Увага

Якщо значенням параметра escape не є порожній рядок (""), то результатом може бути CSV, що не відповідає вимогам » RFC 4180 або не зможе оброблятись функціями PHP CSV. Типовим значенням параметра escape є "\\", але рекомендовано явно вказати порожній рядок. Типове значення зміниться в наступній версії PHP, та не раніше, ніж в 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 в разі помилки.

Помилки/виключення

Throws a ValueError if separator or enclosure is not one byte long.

Throws a ValueError if escape is not one byte long or the empty string.

Журнал змін

Версія Опис
8.4.0 Relying on the default value of escape is now deprecated.
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
= [
[
'aaa', 'bbb', 'ccc', 'dddd'],
[
'123', '456', '789'],
[
'"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"""

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