PHPのfstat()関数の使い方！開いているファイルの情報を取得する方法

fstat()関数とは

fstat()関数は、すでに開かれているファイルに関する情報を取得するためのPHPの組み込み関数です。fopen()などで開いたファイルポインタを渡すことで、そのファイルのサイズや最終更新日時などの属性情報を配列として受け取ることができます。

戻り値の配列に含まれる要素

fstat()関数は、以下の要素を持つ配列を返します。各要素には、数値インデックスと文字列キーの両方でアクセス可能です。

• [0] または [dev] ・・・ デバイス番号
• [1] または [ino] ・・・ inode番号
• [2] または [mode] ・・・ inode保護モード
• [3] または [nlink] ・・・ リンク数
• [4] または [uid] ・・・ 所有者のユーザーID
• [5] または [gid] ・・・ 所有者のグループID
• [6] または [rdev] ・・・ inodeデバイスタイプ
• [7] または [size] ・・・ ファイルサイズ（バイト単位）
• [8] または [atime] ・・・ 最終アクセス時刻（Unixタイムスタンプ）
• [9] または [mtime] ・・・ 最終更新時刻（Unixタイムスタンプ）
• [10] または [ctime] ・・・ 最終inode変更時刻（Unixタイムスタンプ）
• [11] または [blksize] ・・・ ファイルシステムIOのブロックサイズ
• [12] または [blocks] ・・・ 割り当て済みブロック数

構文

fstat(file_pointer)

パラメータ

• file_pointer ・・・ fopen()を使って作成したファイルポインタ。この引数は必須です。

戻り値

fstat()関数は、上記の要素を含む配列を返します。

使用例

<?php
    $file_pointer = fopen("one.txt", "r");
    print_r(fstat($file_pointer));
    fclose($file_pointer);
?>

このコードでは、「one.txt」を読み取りモードで開き、fstat()でファイル情報を取得して表示しています。

出力結果

Array
(
[0] => 0
[1] => 0
[2] => 33206
[3] => 1
[4] => 0
[5] => 0
[6] => 0
[7] => 120
[8] => 1928173529
[9] => 1124185875
[10] => 1114322653
[11] => -1
[12] => -1
[dev] => 0
[ino] => 0
[mode] => 33206
[nlink] => 1
[uid] => 0
[gid] => 0
[rdev] => 0
[size] => 120
[atime] => 1928173529
[mtime] => 1124185875
[ctime] => 1114322653
[blksize] => -1
[blocks] => -1
)

補足：stat()との違いと注意点

同様の情報はstat()関数でも取得できますが、stat()はファイル名を引数に取るのに対し、fstat()は既に開いたファイルポインタを引数に取る点が異なります。また、PHPはファイル情報をキャッシュする仕組みがあるため、常に最新の情報を取得したい場合は、事前にclearstatcache()を呼び出しておくことをおすすめします。