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

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

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

作成日: 更新日:

基本的な使い方

fstatメソッドは、SplFileObjectクラスのインスタンスが指し示す、現在開いているファイルに関する詳細な統計情報を取得するメソッドです。このメソッドは、ファイルシステムの深いレベルで管理されているファイルのメタデータ(属性情報)を連想配列として提供します。具体的には、ファイルのサイズ(バイト単位)、最終アクセス時刻、最終更新時刻、inode最終変更時刻、パーミッション(読み書き権限などのアクセス許可)、所有ユーザーID、所有グループID、ハードリンク数といった、多岐にわたる属性情報を一括して取得できます。PHPの標準的なstat()関数と同じ情報を提供しますが、SplFileObjectインスタンスを通じてオブジェクト指向的に利用できる点が特徴です。システムエンジニアがファイルのバックアップ処理を行う前に更新日時をチェックしたり、ログファイルのサイズが閾値を超えていないか監視したり、特定のファイルに対するアクセス権限をプログラムから検証したりする際に非常に有用です。ファイルの状態を正確に把握し、それに基づいてアプリケーションの動作を制御する場面で活用される、堅牢なファイル操作処理を実装するための重要なツールとなります。

構文(syntax)

1<?php
2$filename = 'temp_file.txt';
3file_put_contents($filename, 'Hello, PHP fstat!');
4
5$file = new SplFileObject($filename, 'r');
6$stats = $file->fstat();
7
8print_r($stats);
9
10unlink($filename);
11?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

array|false

SplFileObject::fstat は、ファイルの状態情報を配列で返します。ファイルの状態情報が取得できなかった場合は false を返します。