【PHP8.x】fgetsメソッドの使い方

fgetsメソッドは、ファイルから1行ずつデータを読み込む処理を実行するメソッドです。

このメソッドは、PHPの標準ライブラリであるStandard PHP Library (SPL) の一部であるSplFileObjectクラスに属しています。SplFileObjectは、ファイルやURLをオブジェクトとして操作するためのクラスで、fgetsメソッドはそのSplFileObjectインスタンスに対して呼び出されます。

具体的には、ファイルオブジェクトが現在指し示しているファイルポインタの位置から、次の改行文字（\n）に達するまで、またはファイルの終端（EOF）に達するまでのデータを読み込みます。読み込まれたデータは文字列として返され、通常、行末に含まれる改行文字もその文字列の一部として含まれます。

読み込みが成功した場合、fgetsメソッドは読み込んだ行の文字列を返します。もしファイルの終端に達した場合や、何らかの理由でファイルからの読み込み中にエラーが発生した場合には、falseを返します。

このメソッドを利用することで、例えば非常に大きなテキストファイル全体を一度にメモリに読み込むことなく、1行ずつ順番に処理することが可能になります。これにより、メモリの使用量を抑えながら効率的にファイルを扱うことができます。ログファイルの解析、CSVファイルの内容の読み込み、設定ファイルの処理など、さまざまな場面で活用される基本的なファイル操作メソッドです。

Copy
1<?php
2$fileObject = new SplFileObject('file.txt');
3$line = $fileObject->fgets();
4?>

引数なし

引数はありません

string|false

ファイルポインタから1行を読み込み、文字列として返します。ファイルの終端に達した場合は false を返します。