fgets
(PHP 4, PHP 5)
fgets — 从文件指针中读取一行
说明
string fgets
( resource $handle
[, int $length
] )
从文件指针中读取一行。
参数
handle
文件指针必须是有效的,必须指向由 fopen() 或 fsockopen() 成功打开的文件(并还未由 fclose() 关闭)。
length
从 handle
指向的文件中读取一行并返回长度最多为 length
- 1
字节的字符串。碰到换行符(包括在返回值中)、EOF 或者已经读取了 length - 1
字节后停止(看先碰到那一种情况)。如果没有指定
length
,则默认为 1K,或者说 1024 字节。
Note:
从 PHP 4.3 开始,忽略掉 length 则行的长度被假定为 1024,将继续从流中读取数据直到行结束。如果文件中的大多数行都大于 8KB,则在脚本中指定最大行的长度在利用资源上更为有效。
返回值
从指针 handle
指向的文件中读取了 length
- 1 字节后返回字符串。
如果文件指针中没有更多的数据了则返回 FALSE
。
错误发生时返回 FALSE
。
更新日志
版本
说明
4.3.0
fgets() 开始二进制安全
4.2.0
length
参数成为可选。
范例
Example #1 逐行读取文件
<?php
$handle = @fopen("/tmp/inputfile.txt", "r");
if ($handle) {
while (($buffer = fgets($handle, 4096)) !== false) {
echo $buffer;
}
if (!feof($handle)) {
echo "Error: unexpected fgets() failn";
}
fclose($handle);
}
?>
注释
Note: 在读取在 Macintosh 电脑中或由其创建的文件时, 如果 PHP 不能正确的识别行结束符,启用运行时配置可选项 auto_detect_line_endings 也许可以解决此问题。
Note:
习惯了 C 语言中 fgets() 语法的人应该注意到 EOF 是怎样被返回的。
参见
fgetss() - 从文件指针中读取一行并过滤掉 HTML 标记 fread() - 读取文件(可安全用于二进制文件) fgetc() - 从文件指针中读取字符 stream_get_line() - 从资源流里读取一行直到给定的定界符 fopen() - 打开文件或者 URL popen() - 打开进程文件指针 fsockopen() - 打开一个网络连接或者一个Unix套接字连接 stream_set_timeout() - Set timeout period on a stream