【PHP】「readfile」関数を使ってファイルを読み込む方法
【PHP】
「readfile」関数を使ってファイルを読み込む方法
「PHP」プログラミングで、
ファイルを読み込む関数の一つ「readfile」関数。
実行すると、出力までしてくれるのが特徴のファイル読み込み関数。
返り値には、ファイル内容の文字数が格納される。
「readfile」関数とは
「readfile」関数は、
ファイル内容全体を読み取る事ができる関数。
特徴的なのは、
読み込んだファイルの内容を、
そのまま標準出力に出力するので、
「echo」「Print」関数の機能を内蔵している。
返り値には、ファイル内容の文字数が格納される。
Back
「readfile」関数の書式
「readfile」関数は、
ファイルを読んで標準出力に書き出します。
返り値は、文字数が格納される。
「readfile」関数の構成
readfile(string $filename, bool $use_include_path = false, resource $context = ?): int|false
readfile(必須, 省略可, 省略可);
readfile(ファイルパス [ , include_path [ , context ]] );
パラメータ
| |
| |
filename |
読み込みたいファイルのURLを指定する。
|
use_include_path |
省略可。
オプションの2番目に記述する引数で、
「TRUE」を指定することにより、
登録されている「Include Path(インクルードパス)」も検索する事が可能。
|
context |
省略可。
ストリームコンテキストリソースは、
ストリームの挙動を変更・拡張できるパラメータで、オプションの集合体。
コンテキストは、「stream_context_create()」を使って生成可能。
ほとんどのファイルシステム関連のストリーム生成関数に渡すことが可能。
|
戻り値 |
「readfile()」の実行結果を格納する「戻り値」。
成功した場合は、ファイルから読み込んだバイト数を返す。
失敗した場合に「false」を返す。
ファイル内容は、実行と同時に出力される。
|
エラー / 例外 |
失敗したときは、エラー「E_WARNING」が発生する。
|
「readfile」関数のサンプルコード
//ファイルを変数に格納
$filename = 'ファイル名.txt';
//readfileでファイルの全文出力
readfile($filename);
Back