stream_get_line

(PHP 5, PHP 7, PHP 8)

stream_get_line指定されたデリミタの位置までのデータを一行分としてストリームから読み込む

説明

stream_get_line(resource $stream, int $length, string $ending = ""): string|false

指定したハンドルから一行取得します。

読み込みは、length バイト読まれたか、 ending で指定された空でない文字列がストリームに見つかったか (この文字列は返値に 含まれません)、あるいは EOF に達したとき、のうち一番最初に遭遇したところで停止します。

この関数は fgets() とほとんど同一ですが、 \n や \r 、\r\n といった一般的な文字列以外を行末を示すデリミタ として指定できる点で、またデリミタ自体を返値に 含まない 点で異なります。

パラメータ

stream

有効なファイルハンドル。

length

ハンドルから読み込む最大バイト数。 負の値はサポートされていません。 ゼロ(0) を指定すると、 ソケットのデフォルトのチャンクサイズ つまり、8192 を使います。

ending

オプションのデリミタ文字列。

戻り値

最大 length バイトの、 stream で指定されたファイルから読み込んだデータを返します。 失敗した場合に false を返します

参考

  • fread() - バイナリセーフなファイルの読み込み
  • fgets() - ファイルポインタから 1 行取得する
  • fgetc() - ファイルポインタから1文字取り出す
関連キーワード:  デリミタ, ストリーム, データ, 一行, stream, 位置, 指定, length, ending, バイト