Filesystem 函数
PHP Manual

fgetcsv

(PHP 4, PHP 5)

fgetcsv从文件指针中读入一行并解析 CSV 字段

说明

array fgetcsv ( int $handle [, int $length [, string $delimiter [, string $enclosure ]]] )

handle
一个由 fopen()popen()fsockopen() 产生的有效文件指针。
length (可选)
必须大于 CVS 文件内最长的一行。在 PHP 5 中该参数是可选的。如果忽略(在 PHP 5.0.4 以后的版本中设为 0)该参数的话,那么长度就没有限制,不过可能会影响执行效率。
delimiter (可选)
设置字段分界符(只允许一个字符),默认值为逗号。
enclosure (可选)
设置字段环绕符(只允许一个字符),默认值为双引号。该参数是在 PHP 4.3.0 中添加的。

fgets() 类似,只除了 fgetcsv() 解析读入的行并找出 CSV 格式的字段然后返回一个包含这些字段的数组。

fgetcsv() 出错时返回 FALSE,包括碰到文件结束时。

Note: CSV 文件中的空行将被返回为一个包含有单个 null 字段的数组,不会被当成错误。

Example #1 读取并显示 CSV 文件的整个内容

<?php
$row 
1;
$handle fopen("test.csv","r");
while (
$data fgetcsv($handle1000",")) {
    
$num count($data);
    echo 
"<p> $num fields in line $row: <br>\n";
    
$row++;
    for (
$c=0$c $num$c++) {
        echo 
$data[$c] . "<br>\n";
    }
}
fclose($handle);
?>

从 PHP 4.3.5 起, fgetcsv() 的操作是二进制安全的。

Note: 该函数对区域设置是敏感的。比如说 LANG 设为 en_US.UTF-8 的话,单字节编码的文件就会出现读取错误。

Note: 在读取在 Macintosh 电脑中或由其创建的文件时, 如果 PHP 不能正确的识别行结束符,启用运行时配置可选项 auto_detect_line_endings 也许可以解决此问题。

参见 explode()file()pack()fputcsv()

参数

handle

A valid file pointer to a file successfully opened by fopen(), popen(), or fsockopen().

length

Must be greater than the longest line (in characters) to be found in the CSV file (allowing for trailing line-end characters). It became optional in PHP 5. Omitting this parameter (or setting it to 0 in PHP 5.0.4 and later) the maximum line length is not limited, which is slightly slower.

delimiter

Set the field delimiter (one character only).

enclosure

Set the field enclosure character (one character only).

escape

Set the escape character (one character only). Defaults as a backslash.

返回值

Returns an indexed array containing the fields read.

Note:

A blank line in a CSV file will be returned as an array comprising a single null field, and will not be treated as an error.

Note: 在读取在 Macintosh 电脑中或由其创建的文件时, 如果 PHP 不能正确的识别行结束符,启用运行时配置可选项 auto_detect_line_endings 也许可以解决此问题。

fgetcsv() returns NULL if an invalid handle is supplied or FALSE on other errors, including end of file.

更新日志

版本 说明
5.3.0 The escape parameter was added
4.3.5 fgetcsv() is now binary safe
4.3.0 The enclosure parameter was added

范例

Example #2 Read and print the entire contents of a CSV file

<?php
$row 
1;
if ((
$handle fopen("test.csv""r")) !== FALSE) {
    while ((
$data fgetcsv($handle1000",")) !== FALSE) {
        
$num count($data);
        echo 
"<p> $num fields in line $row: <br /></p>\n";
        
$row++;
        for (
$c=0$c $num$c++) {
            echo 
$data[$c] . "<br />\n";
        }
    }
    
fclose($handle);
}
?>

注释

Note:

Locale setting is taken into account by this function. If LANG is e.g. en_US.UTF-8, files in one-byte encoding are read wrong by this function.

参见


Filesystem 函数
PHP Manual