SplFileObject::setCsvControl
(PHP 5 >= 5.2.0, PHP 7, PHP 8)
SplFileObject::setCsvControl — Set the delimiter, enclosure and escape character for CSV
This function has been DEPRECATED as of PHP 8.6.0. Relying on this function is highly discouraged.
说明
since: '8.6')]public function SplFileObject::setCsvControl(string
$separator = ",", string $enclosure = "\"", string $escape = "\\"): voidSets the delimiter, enclosure and escape character for parsing CSV fields.
参数
separator
可选的 separator 参数,设置字段分隔符。必须是单字节字符。
enclosure
可选的 enclosure 参数,设置字段环绕符。必须是单字节字符。
escape
可选的 escape
参数,设置转义字符。必须是单字节字符或者空字符串。空字符串("")禁用所有的转义机制。
在输入流中,enclosure 字符在引号字符串内可通过重复自身进行转义,解析后结果中将只保留一个
enclosure 字符。而 escape 字符的行为有所不同:若输入中出现
escape 字符与 enclosure
字符的组合序列,这两个字符都会保留在解析结果中。因此,在默认参数下,类似 "a""b","c\"d" 的 CSV
行将被解析为两个字段,分别为 a"b 和 c\"d。
从 PHP 8.4.0 开始,弃用依赖 escape 的默认值。需要通过位置或使用命名参数明确提供。
当 escape 被设置为非空字符串("")时,
可能导致生成的 CSV 不符合 » RFC 4180 的要求,
或者无法通过 PHP CSV 函数的往返处理。
escape 的默认值是 "\\",因此建议显式地将其设置为空字符串。
默认值将在未来的 PHP 版本中更改,不早于 PHP 9.0。
返回值
没有返回值。
更新日志
| 版本 | 说明 |
|---|---|
| 8.6.0 | This method has been deprecated. |
| 8.4.0 | 现在已弃用依赖 escape 的默认值。 |
| 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 ?>
参见
- SplFileObject::getCsvControl() - Get the delimiter, enclosure and escape character for CSV
- SplFileObject::fgetcsv() - Gets line from file and parse as CSV fields
- SplFileObject::fputcsv() - Write a field array as a CSV line
- fputcsv() - 将行格式化为 CSV 并写入文件指针
- fgetcsv() - 从文件指针中读入一行并解析 CSV 字段
- str_getcsv() - 解析 CSV 字符串为一个数组
来源:PHP Documentation Group · 作者与贡献记录 · CC BY 3.0。离线整理了版式、链接和媒体显示。
