(PHP 5 >= 5.2.0, PHP 7, PHP 8)
SplFileObject::setCsvControl — Set the delimiter, enclosure and escape character for CSV
$separator = ",", string $enclosure = "\"", string $escape = "\\"): voidSets the delimiter, enclosure and escape character for parsing CSV fields.
separatorThe field delimiter (one single-byte character only).
enclosureThe field enclosure character (one single-byte character only).
escape
The field escape character (at most one single-byte character).
An empty string ("") disables the proprietary escape mechanism.
When escape is set to anything other than an empty string
("") it can result in CSV that is not compliant with
» RFC 4180 or unable to survive a roundtrip
through the PHP CSV functions. The default for escape is
"\\" so it is recommended to set it to the empty string explicitly.
The default value will change in a future version of PHP, no earlier than PHP 9.0.
No value is returned.
| Version | Description |
|---|---|
| 7.4.0 |
The escape parameter now also accepts an empty
string to disable the proprietary escape mechanism.
|
Example #1 SplFileObject::setCsvControl() example
<?php
$file = new SplFileObject("data.csv");
$file->setFlags(SplFileObject::READ_CSV);
$file->setCsvControl('|');
foreach ($file as $row) {
list ($fruit, $quantity) = $row;
// Do something with values
}
?>Contents of data.csv
<?php apples|20 bananas|14 cherries|87 ?>