PHP: SplFileObject::fputcsv - Manual

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

SplFileObject::fputcsv — Write a field array as a CSV line

Parameters

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.

Warning

In the input stream, the enclosure character can always be escaped by doubling it inside a quoted string, resulting in a single enclosure character in the parsed result. The escape character works differently: If a sequence of escape and enclosure characters appear in the input, both characters will be present in the parsed result. So for the default parameters, a CSV line like "a""b","c\"d" will have the fields parsed as a"b and c\"d, respectively.

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.

Errors/Exceptions

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.

Changelog

Examples

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

?>

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

See Also

• 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() - Format line as CSV and write to file pointer
• fgetcsv() - Gets line from file pointer and parse for CSV fields
• str_getcsv() - Parse a CSV string into an array