PHP fgets()関数
定義と使用方法
fgets()関数はファイルポインタから一行を読み取ります。
文法
fgets(file,length)
| パラメータ | 説明 |
|---|---|
| file | 必須。読み込むファイルを定義します。 |
| length | 選択可能。読み込む必要のあるバイト数を定義します。デフォルトは1024バイトです。 |
説明
から file 指定されたファイルから一行を読み取り、長さが最大で length - 1 バイトの文字列。改行符（返り値に含まれる場合も含め）、EOF または指定された行数を超えた場合に停止します。 length - 1 バイト前に停止します（どちらの条件が先に該当するかによる）。指定されていない場合 length、デフォルトでは 1K、つまり 1024 バイトになります。
失敗した場合、false を返します。
ヒントと注記
注記：length 引数は PHP 4.2.0 からオプションとなりました。省略すると、行の長さは 1024 バイトと仮定されます。PHP 4.3 からは省略されます。 length データを流から読み続け、行終端まで読み取ります。ファイルの多くの行が 8 KB 以上の場合、スクリプトで最大行長を指定することでリソースの利用がより効果的です。
注記：PHP 4.3 からこの関数はバイナリファイルに対して安全に使用できます。初期のバージョンでは使用できません。
注記：PHP がファイルを読み込む際に Macintosh ファイルの行終端記号を認識できない場合、auto_detect_line_endings 运行時設定オプションを有効にすることができます。
例
例 1
<?php
$file = fopen("test.txt","r");
echo fgets($file);
fclose($file);
?>
出力は以下のようになります：
こんにちは、これはテストファイルです。
例 2
<?php
$file = fopen("test.txt","r");
while(! feof($file))
{
echo fgets($file) . "<br />";
}
fclose($file);
?>
出力は以下のようになります：
こんにちは、これはテストファイルです。 ここには 3 行あります。 これは最後の行です。
