SplFileObject::fputcsv
(PHP 5 >= 5.4.0, PHP 7, PHP 8)
SplFileObject::fputcsv — Write a field array as a CSV line
Description
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
separatorparameter sets the field delimiter (one single-byte character only). -
enclosure -
The optional
enclosureparameter sets the field enclosure (one single-byte character only). -
escape -
The optional
escapeparameter sets the escape character (at most one single-byte character). An empty string ("") disables the proprietary escape mechanism. -
eol -
The optional
eolparameter sets a custom End of Line sequence.
Note:
If an
enclosurecharacter is contained in a field, it will be escaped by doubling it, unless it is immediately preceded by anescape.
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"""
See Also
- fputcsv() - Format line as CSV and write to file pointer
- SplFileObject::fgetcsv() - Gets line from file and parse as CSV fields
