phpday 2025 - Call For Papers

SplFileObject::fputcsv

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

SplFileObject::fputcsvWrite a field array as a CSV line

Опис

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

Writes the fields array to the file as a CSV line.

Параметри

fields

An array of values.

separator

The field delimiter (one single-byte character only). By default , or the value set by a prior call to SplFileObject::setCsvControl().

enclosure

The field enclosure character (one single-byte character only). By default " or the value set by a prior call to SplFileObject::setCsvControl().

escape

The escape character (at most one single-byte character). By default \ or the value set by a prior call to SplFileObject::setCsvControl(). An 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, or by a call to SplFileObject::setCsvControl().

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 SplFileObject::fputcsv() example

<?php

$list
= array (
array(
'aaa', 'bbb', 'ccc', 'dddd'),
array(
'123', '456', '789'),
array(
'"aaa"', '"bbb"')
);

$file = new SplFileObject('file.csv', 'w');

foreach (
$list as $fields) {
$file->fputcsv($fields);
}

?>

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

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

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

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top