SplFileObject::fputcsv

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

SplFileObject::fputcsv — Write 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.

错误／异常

如果 separator 或者 enclosure 长度不是一个字节，则抛出 ValueError。

如果 escape 的长度不是一个字节或者为空字符串，则抛出 ValueError。

更新日志

版本	说明
8.4.0	现在已弃用依赖 escape 的默认值。
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"""

参见

SplFileObject::fgetcsv() - Gets line from file and parse as CSV fields
SplFileObject::setCsvControl() - Set the delimiter, enclosure and escape character for CSV
SplFileObject::getCsvControl() - Get the delimiter, enclosure and escape character for CSV
fputcsv() - 将行格式化为 CSV 并写入文件指针
fgetcsv() - 从文件指针中读入一行并解析 CSV 字段
str_getcsv() - 解析 CSV 字符串为一个数组

发现了问题？

了解如何改进此页面 • 提交拉取请求 • 报告一个错误

＋添加备注

SplFileObject::fputcsv

说明

参数

返回值

错误／异常

更新日志

示例

参见

发现了问题？

用户贡献的备注