【PHP8.x】fstat関数の使い方

fstat関数は、既に開かれているファイルリソース（ファイルポインタ）から、そのファイルに関する詳細な統計情報を取得する関数です。この関数は、fopen()などで開かれたファイルリソースを引数として受け取ります。成功した場合、ファイルに関する様々な情報を含む配列を返します。

返される配列には、ファイルのサイズ、最終アクセス時刻、最終更新時刻、ファイルのパーミッション、所有者ID、グループIDといった多岐にわたる属性が含まれています。これらの情報は、数値インデックスと、より読みやすい連想配列キー（例えば、ファイルのバイト単位のサイズは['size']や[7]でアクセス可能）の両方で提供されます。例えば、ファイルのサイズを確認したり、特定の日時以降に更新されたファイルを検出したりする際に役立ちます。

この関数は、ファイルの状態をプログラムで確認したい場合に非常に有用です。ファイルの読み書きを行う前に、そのファイルのサイズや権限を把握しておくことで、予期せぬエラーを防ぐことができます。ファイル情報の取得に失敗した場合はfalseを返すため、関数の呼び出し後には戻り値を必ず確認し、適切なエラーハンドリングを行うことが重要です。

<?php
$fileHandle = fopen('php://temp', 'r');
$fileStatistics = fstat($fileHandle);
fclose($fileHandle);
?>

resource $stream

• resource $stream: ファイルリソースやソケットリソースなどのファイルポインタを指定するリソース型

array|false

fstat関数は、指定されたファイルポインタに関連付けられたファイルの状態を示す配列、またはエラーが発生した場合はfalseを返します。