SplFileObject::fgetcsv

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

SplFileObject::fgetcsv — Gets line from file and parse as CSV fields

说明

public SplFileObject::fgetcsv(string $separator = ",", string $enclosure = "\"", string $escape = "\\"): array|false

Gets 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, the escape character can be used as an alternative. So for the default parameter values "" and \" have the same meaning. Other than allowing to escape the enclosure character the escape 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 using SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE, in which case empty lines are skipped.

错误／异常

如果 separator 或者 enclosure 长度不是一个字节，则抛出 ValueError。

如果 escape 的长度不是一个字节或者为空字符串，则抛出 ValueError。

更新日志

版本	说明
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::fputcsv() - Write a field array as a CSV line
SplFileObject::setCsvControl() - Set the delimiter, enclosure and escape character for CSV
SplFileObject::getCsvControl() - Get the delimiter, enclosure and escape character for CSV
SplFileObject::setFlags() - Sets flags for the SplFileObject
SplFileObject::READ_CSV
SplFileObject::current() - Retrieve current line of file
fputcsv() - 将行格式化为 CSV 并写入文件指针
fgetcsv() - 从文件指针中读入一行并解析 CSV 字段
str_getcsv() - 解析 CSV 字符串为一个数组

发现了问题？

了解如何改进此页面 • 提交拉取请求 • 报告一个错误

＋添加备注

用户贡献的备注 6 notes

down

android991 at gmail dot com ¶

6 years ago

Be aware.
There is bug 46569 persists that breaks usage of SplFileObject::fgetcsv() after SplFileObject::seek()-ing to a non-zero position and then returns the contents of wrong line - off by one
<?php
$file = new SplFileObject('foo/bar.csv');
$file->seek(1);
print_r($file->fgetcsv()); // reads 3rd line against 2nd

down

InvisibleSmiley ¶

3 years ago

Not that this may return NULL instead of FALSE depending on the given SplFileObject flags in versions prior to PHP 8.1.

Change: https://github.com/php/php-src/commit/188b1d4c7c7b3482584e248522d94e06ba616a1c

Testcase: https://3v4l.org/6dQTT

down

Denitz ¶

6 years ago

If your CSV doesn't have enclosures, you can face an issue with default " identified as enclosure in data. Empty $enclosure is not allowed, but you can use same $enclosure as $delimiter (\n by default) to emulate empty enclosure.

down

v-fpiris at teknober dot com ¶

13 years ago

after setting the delimiter '\t' fgetcsv() truncates the value when it is empty string 


workaround:


<?php

$file = new SplFileObject($path);

$file->setFlags(SplFileObject::DROP_NEW_LINE);

while ($file->valid()) {

$line = $file->fgets();

$line = explode("\t", $line);


print_r($line);

}

?>

down

vaughn dot clayton+php at servicetrade dot com ¶

12 years ago

Note that due to bugs 55807 and 61032, introduced in 5.3.8, if the csv in example #2 has a newline character at the end of each line, the foreach will execute 6 times.

The last time through the loop $row will be bool(false). This is true even if using SplFileObject::SKIP_EMPTY and SplFileObject::DROP_NEW_LINE.

Until the bug is fixed, the workaround is to also add SplFileObject::READ_AHEAD to your setFlags() call.

down

jbrauer ¶

5 years ago

Also while the enclosure character cannot be NULL you can set it to ASCII NUL character chr(0) with the same practical effect.