(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.
Зауваження: 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.
Якщо значенням параметра escape не є порожній рядок
(""), то результатом може бути CSV, що не відповідає вимогам
» RFC 4180 або не зможе оброблятись
функціями PHP CSV. Типовим значенням параметра escape є
"\\", але рекомендовано явно вказати порожній рядок. Типове
значення зміниться в наступній версії PHP, та не раніше, ніж в PHP 9.0.
Не повертає значень.
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.
| Версія | Опис |
|---|---|
| 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.
|
Приклад #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 ?>