# fgetcsv

(PHP 4, PHP 5, PHP 7)

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

### 说明

fgetcsv ( resource `$handle` [, int `$length` = 0 [, string `$delimiter` = ',' [, string `$enclosure` = '"' [, string `$escape` = '\\' ]]]] ) : array

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

### 参数

`handle`

  一个由 fopen()、popen() 或 fsockopen() 产生的有效文件指针。

`length`

  必须大于 CVS 文件内最长的一行。在 PHP 5 中该参数是可选的。如果忽略（在 PHP 5.0.4 以后的版本中设为 0）该参数的话，那么长度就没有限制，不过可能会影响执行效率。

`delimiter`

  设置字段分界符（只允许一个字符）。

`enclosure`

  设置字段环绕符（只允许一个字符）。

`escape`

  设置转义字符（只允许一个字符），默认是一个反斜杠。

### 返回值

返回包含读取字段的索引数组。

> Note:

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

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

如果提供了无效的文件指针，fgetcsv() 会返回 `NULL`。 其他错误，包括碰到文件结束时返回 `FALSE`，。

### 更新日志

版本 | 说明
--- | ---
5.3.0 | 增加了 `escape` 参数。
4.3.5 | 现在起 fgetcsv() 的操作是二进制安全的。
4.3.0 | 增加了 `enclosure` 参数。

### 范例

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

    <?php
    $row = 1;
    if (($handle = fopen("test.csv", "r")) !== FALSE) {
        while (($data = fgetcsv($handle, 1000, ",")) !== 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:

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

### 参见

- str_getcsv() - 解析 CSV 字符串为一个数组
- explode() - 使用一个字符串分割另一个字符串
- file() - 把整个文件读入一个数组中
- pack() - 将数据打包成二进制字符串
- fputcsv() - 将行格式化为 CSV 并写入文件指针