【PHP8.x】SplFileObject::getMTime()メソッドの使い方

Copy
1<?php
2
3/**
4 * 指定されたファイルの最終更新時刻を取得し、表示する関数。
5 *
6 * @param string $filePath 処理するファイルのパス
7 * @return void
8 */
9function displayFileModificationTime(string $filePath): void
10{
11    // このサンプルコードを単体で動作させるため、一時的なファイルを作成します。
12    // 通常は、既に存在するファイルパスを引数として渡して使用します。
13    if (!file_exists($filePath)) {
14        file_put_contents($filePath, "This is a temporary file for testing SplFileObject::getMTime.\n");
15        echo "情報: テストファイル '{$filePath}' を作成しました。\n";
16    } else {
17        echo "情報: 既存のファイル '{$filePath}' を使用します。\n";
18    }
19
20    try {
21        // SplFileObject インスタンスを作成し、読み込みモード ('r') でファイルを開きます。
22        // これにより、ファイルへのアクセスや操作が可能になります。
23        $file = new SplFileObject($filePath, 'r');
24
25        // ファイルの最終更新時刻（最終的に内容が変更された時刻）を取得します。
26        // 戻り値はUnixタイムスタンプ (int) またはエラー時に false です。
27        $mtime = $file->getMTime();
28
29        if ($mtime === false) {
30            // getMTime() が false を返した場合、時刻の取得に失敗しています。
31            echo "エラー: ファイル '{$filePath}' の最終更新時刻を取得できませんでした。\n";
32        } else {
33            echo "ファイル '{$filePath}' の最終更新時刻 (Unixタイムスタンプ): " . $mtime . "\n";
34            // Unixタイムスタンプを人が読みやすい日付・時刻形式に変換して表示します。
35            echo "読みやすい形式: " . date('Y-m-d H:i:s', $mtime) . "\n";
36        }
37
38    } catch (RuntimeException $e) {
39        // SplFileObjectのコンストラクタで発生するエラー（例: ファイルが見つからない、
40        // アクセス権がないなど）を捕捉し、メッセージを表示します。
41        echo "エラー: " . $e->getMessage() . "\n";
42    } finally {
43        // サンプルコードで作成した一時ファイルをクリーンアップのため削除します。
44        // 実際のアプリケーションでは、既存のファイルを勝手に削除しないように注意し、
45        // この部分を適切に調整してください。
46        if (file_exists($filePath)) {
47            unlink($filePath);
48            echo "情報: テストファイル '{$filePath}' を削除しました。\n";
49        }
50    }
51}
52
53// 関数の実行例: 'sample_file_for_getmtime.txt' という名前のファイルを使用します。
54$testFileName = 'sample_file_for_getmtime.txt';
55displayFileModificationTime($testFileName);
56
57?>

SplFileObject::getMTimeメソッドは、PHPで指定されたファイルの最終更新時刻を取得するために利用されます。このメソッドは、ファイルをオブジェクトとして扱うためのSplFileObjectクラスに属しており、ファイル操作をより直感的かつオブジェクト指向的に行うことを可能にします。

サンプルコードでは、まず一時的なテストファイルを作成し、そのファイルパスを使用してSplFileObjectのインスタンスを生成しています。インスタンスを作成することで、ファイルのプロパティやメソッドにアクセスできるようになります。

$file->getMTime()を呼び出すと、そのファイルが最後に内容変更された時刻を取得できます。このメソッドは引数を必要としません。戻り値は、成功した場合にはUnixタイムスタンプという形式の整数値（int）で、これは1970年1月1日00:00:00 UTCからの経過秒数を表します。もし時刻の取得に失敗した場合や、ファイルが存在しないなどの問題が発生した場合は、falseが返されます。

取得したUnixタイムスタンプは、そのままでは人が読みにくいため、date('Y-m-d H:i:s', $mtime)のようにdate関数と組み合わせて使用することで、「年-月-日 時:分:秒」といった分かりやすい形式に変換して表示できます。コードでは、エラー発生時にfalseが返された場合や、SplFileObjectの生成に失敗した場合（RuntimeException）に対処するエラーハンドリングも行われており、安定したファイル操作を実現する上で重要な考慮点です。