Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

freadメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

freadメソッドは、SplFileObjectが扱うファイルから、指定されたバイト数のデータを読み込むことを実行するメソッドです。

このメソッドは、ファイル内の現在のポインタ位置から、指定された最大バイト数だけデータを読み取り、文字列として返します。読み込むバイト数は正の整数で指定します。データが読み込まれると、ファイルの内部ポインタは読み込んだバイト数分自動的に進むため、その後の読み込みは前回の終端から開始されます。

freadメソッドの主な利点は、大きなファイルを効率的に処理できる点です。ファイルを一度にメモリに読み込まず、このメソッドで部分的に処理することでメモリ使用量を抑えられます。巨大なファイルから特定のデータを抽出したり、順次処理したりする際に特に有用です。

読み込みが成功すると、読み取ったデータが文字列で返されます。ファイルの終端に達した場合や、読み込み中にエラーが発生した場合は、空の文字列が返されます。このメソッドは、SplFileObjectクラスに組み込まれており、ファイル操作機能の一つです。

構文(syntax)

1<?php
2$fileObject = new SplFileObject('path/to/file.txt', 'r');
3$data = $fileObject->fread(1024);
4?>

引数(parameters)

int $length

  • int $length: 読み込むバイト数を指定する整数

戻り値(return)

string|false

指定されたバイト数だけファイルを読み込み、その内容を文字列として返します。ファイルの終端に達したか、読み込み中にエラーが発生した場合は false を返します。

関連コンテンツ