(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.
separator
The separator parameter sets the field separator.
It must be a single byte character.
enclosure
The enclosure parameter sets the field enclosure character.
It must be a single byte character.
escape
The escape parameter sets the escape character.
It must be a single byte character or the empty string.
The empty string ("") disables the proprietary escape mechanism.
Note: Usually an
enclosurecharacter is escaped inside a field by doubling it; however, theescapecharacter can be used as an alternative. So for the default parameter values""and\"have the same meaning. Other than allowing to escape theenclosurecharacter theescapecharacter 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.
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.
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.
| Version | Description |
|---|---|
| 8.4.0 |
Relying on the default value of escape is now
deprecated.
|
| 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 ?>