【PHP8.x】SplFileObject::fpassthru()メソッドの使い方

fpassthruメソッドは、SplFileObjectクラスに属し、現在のファイルポインタが指し示している位置から、ファイルの終端まですべての残りのデータを出力するメソッドです。このメソッドは、ファイルの内容を直接、ウェブサーバーの出力バッファ、つまりウェブブラウザに表示される内容として書き出したい場合に非常に役立ちます。例えば、サーバー上にある画像ファイルやPDFファイルなどのコンテンツを、PHPスクリプトを介してユーザーに直接ダウンロードさせたり、ブラウザに表示させたりする際に利用できます。

大きなファイルを扱う際でも、ファイル全体を一度にメモリに読み込む必要がないため、メモリ使用量を抑えながら効率的にデータを出力することが可能です。これにより、サーバーのリソース消費を軽減し、パフォーマンスの向上に貢献します。メソッドが実行されると、ファイルポインタはファイルの終端まで移動します。戻り値としては、正常に出力されたバイト数が整数で返されます。何らかのエラーが発生して出力に失敗した場合は、falseが返されます。

このメソッドを使用する際には、出力するファイルのタイプに応じてheader()関数で適切なHTTPヘッダ（例えばContent-TypeやContent-Dispositionなど）を設定することが一般的です。これにより、ブラウザにファイルの種類を正しく伝え、適切な処理を促すことができます。

Copy
1<?php
2$file = new SplFileObject('path/to/your/file.txt', 'r');
3$file->fpassthru();
4?>

引数なし

引数はありません

戻り値なし

戻り値はありません