fgets ( resource [, int ])

解説

引数で指定したファイルポインタから一行読み出し、その文字列を返します。ただし読み出しは、第二引数 - 1 バイト読み出したか、改行文字を検出したか、EOFに達したかのいずれかで終了します。第二引数が指定されなかった場合は、デフォルトで 1k または1024バイトとなります。エラーが起こった場合、FALSEを返します。

要件

これらの関数は、標準モジュールの一部として利用可能であり、常に使用できます。

インストールの手順

これらの関数はPHPコアに含まれるため、使用する際にインストールは不要です。

実行用の設定

php.iniの設定により変化します。

allow_url_fopen boolean

このオプションにより、URL対応のfopenラッパーが使用可能となり、ファイルのようにURLオブジェクトをアクセスできるようになります。デフォルトのラッパーが、ftpまたはhttpプロトコルを用いてリモートファイルに アクセスするために提供されています。zlibのようないくつかの拡張モジュールが ラッパーを追加することがあります。

user_agent string

送信する PHP 用のユーザエージェントを定義します。

default_socket_timeout integer

ソケットベースのストリームのデフォルトの有効時間(単位は秒)を定義します。

from="dummy@dummy.jp" string

匿名ftp用パスワード(自分のemailアドレス)を定義します。

auto_detect_line_endings boolean

onにした場合、PHPは fgets() および file() により読み込まれたデータを評価し、UNIX、MS-DOS、Machintoshの行末 表記を使用しているかどうかを調べます。デフォルトはOffとなっています。

リソース型

この拡張モジュールはリソース型を全く定義しません。

記述例

<?php
$handle = fopen ("../index.html", "r");
while (!feof ($handle)) {
    $buf = fgets($handle);
    print $buf;
}
fclose ($handle);
?>