PHP - Manual: SplFileObject::fgetcsv

2024-12-22

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.

注意:
The locale settings are taken into account by this function. If LC_CTYPE is e.g. en_US.UTF-8, files in one-byte encodings may be read wrongly by this function.

参数

separator: The field delimiter (one single-byte character only). Defaults as a comma or the value set using SplFileObject::setCsvControl().
enclosure: The field enclosure character (one single-byte character only). Defaults as a double quotation mark or the value set using SplFileObject::setCsvControl().
escape: The escape character (at most one single-byte character). Defaults as a backslash (\) or the value set using SplFileObject::setCsvControl(). An empty string ("") disables the proprietary escape mechanism.

注意: Usually an enclosure character is escpaped 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.

返回值

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.

更新日志

版本	说明
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::setCsvControl() - Set 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

add a note

User Contributed Notes 6 notes

down

android991 at gmail dot com ¶

3 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

v-fpiris at teknober dot com ¶

11 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

Denitz ¶

3 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

vaughn dot clayton+php at servicetrade dot com ¶

9 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

InvisibleSmiley ¶

7 months 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

jbrauer ¶

2 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.

add a note

官方地址：https://www.php.net/manual/en/splfileobject.fgetcsv.php

有任何技术问题请点击这里网站运营推广招聘

IT PHP 编程语言 Linux 开发编程科技 Elasticsearch HTML/CSS/XML 网络数据库 JAVA 面试 NoSQL C/C++ Golang Git 算法操作系统正则表达式 Redis 互联网 MySql JavaScript 运维软件国际架构设计 Mac OS TCP/IP Excel Vim Windows Socket Oracle VR MongoDB Python 运营 MemCache 商业硬件电子娱乐设计 nginx 摄影游戏 WordPress HTTP 团建数码电器

php7 安装fileinfo扩展 preg_split — 通过一个正则表达式分隔字符串 php位值,解决 PHP 中 usort 在值相同时改变原始位置的问题 [PHP] inet_pton/inet_ntop IP地址转换函数 PHP 8.1 [鸟哥]PHP_INT_MIN 和 -9223372036854775808 adodb手册 ADORecordSet对象 opcache预加载 Composer的Packagist资源 array_multisort() 多字段排序 PHPMailer设置utf8 PHPMailer字符集CharSet mysql面试题 PHP json解析（json_decode）页面工具纯php实现DES以及TripleDES加密算法 php中几种注释规范 php 修改图片大小两千行PHP学习笔记支持php7的性能采集扩展 [原创]诡异的php-fpm超时问题

略微加速

PHP官方手册 - 互联网笔记

SplFileObject::fgetcsv

说明

参数

返回值

更新日志

范例

参见

User Contributed Notes 6 notes