streamWrapper::stream_read

(PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8)

streamWrapper::stream_readストリームから読み込む

説明

public streamWrapper::stream_read(int $count): string|false

このメソッドは、fread() および fgets() に対応してコールされます。

注意:

ストリームの読み込み/書き込み位置 (読み込みに成功したバイト数ぶん) の更新を忘れないようにしましょう。

パラメータ

count

現在位置から何バイトぶんのデータを返すか。

戻り値

count バイト未満のデータしか存在しない場合は、 返せる限りのデータを返します。もうデータがない場合は、空文字列を返します。 読み込みが失敗した場合は、false を返します。

エラー / 例外

このメソッドのコールに (未実装などの理由で) 失敗した場合、 E_WARNING を発行します。

注意:

戻り値が count より長い場合は E_WARNING エラーが発生し、余分なデータは失われます。

注意

注意:

streamWrapper::stream_eof() は、 streamWrapper::stream_read() がコールされた後に直接コールされ、 EOF に達したかどうかを調べます。実装されていない場合は EOF だとみなされます。

警告

ファイル全体を (file_get_contents() などで) 読み込む場合、PHP はループ内で streamWrapper::stream_read() をコールしてから streamWrapper::stream_eof() をコールします。 しかし、streamWrapper::stream_read() が空でない文字列を返す限りは streamWrapper::stream_eof() の戻り値を無視します。

参考

  • fread() - バイナリセーフなファイルの読み込み
  • fgets() - ファイルポインタから 1 行取得する

関連キーワード:  streamWrapper, stream, ストリーム, コール, read, データ, count, 注意, eof, バイト