Write a field array as a CSV line

Description

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.

Parameters

fields: An array of values.
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.

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

Return Values

Returns the length of the written string or false on failure.

Returns false, and does not write the CSV line to the file, if the separator or enclosure parameter is not a single character.

Errors/Exceptions

An E_WARNING level error is issued if the separator or enclosure parameter is not a single character.

Changelog

Version	Description
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.

Examples

Example #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::fputcsv