(PHP 5 >= 5.1.0, PHP 7, PHP 8)
SplFileObject::fgetcsv — Gets line from file and parse as CSV fields
$separator
= ",", string $enclosure
= "\"", string $escape
= "\\"): array|falseGets a line from the file which is in CSV format and returns an array containing the fields read.
注意:
此函数会考虑区域设置。例如,如果
LC_CTYPE
为en_US.UTF-8
,可能会错误的解析某些单字节编码的数据。
separator
The field delimiter (one single-byte character only).
By default ,
or the value set by a prior call to
SplFileObject::setCsvControl().
enclosure
The field enclosure character (one single-byte character only).
By default "
or the value set by a prior call to
SplFileObject::setCsvControl().
escape
The escape character (at most one single-byte character).
By default \
or the value set by a prior call to
SplFileObject::setCsvControl().
An empty string (""
) disables the proprietary escape mechanism.
注意: Usually an
enclosure
character is escaped inside a field by doubling it; however, theescape
character can be used as an alternative. So for the default parameter values""
and\"
have the same meaning. Other than allowing to escape theenclosure
character theescape
character 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,
or by a call to SplFileObject::setCsvControl().
当 escape
被设置为非空字符串(""
)时,
可能导致生成的 CSV 不符合 » RFC 4180 的要求,
或者无法通过 PHP CSV 函数的往返处理。
escape
的默认值是 "\\"
,因此建议显式地将其设置为空字符串。
默认值将在未来的 PHP 版本中更改,不早于 PHP 9.0。
Returns an indexed array containing the fields read, or false
on error.
注意:
A blank line in a CSV file will be returned as an array comprising a single
null
field unless usingSplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE
, in which case empty lines are skipped.
版本 | 说明 |
---|---|
8.4.0 | 现在已弃用依赖 escape 的默认值。 |
7.4.0 |
The escape parameter now also accepts an empty
string to disable the proprietary escape mechanism.
|
示例 #1 SplFileObject::fgetcsv() example
<?php
$file = new SplFileObject("data.csv");
while (!$file->eof()) {
var_dump($file->fgetcsv());
}
?>
示例 #2 SplFileObject::READ_CSV
example
<?php
$file = new SplFileObject("animals.csv");
$file->setFlags(SplFileObject::READ_CSV);
foreach ($file as $row) {
list($animal, $class, $legs) = $row;
printf("A %s is a %s with %d legs\n", $animal, $class, $legs);
}
?>
Contents of animals.csv
crocodile,reptile,4 dolphin,mammal,0 duck,bird,2 koala,mammal,4 salmon,fish,0
以上示例的输出类似于:
A crocodile is a reptile with 4 legs A dolphin is a mammal with 0 legs A duck is a bird with 2 legs A koala is a mammal with 4 legs A salmon is a fish with 0 legs
SplFileObject::READ_CSV