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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内の各エントリ（ファイルやサブディレクトリ）の
5 * 最終アクセス時刻（Access Time）を表示します。
6 *
7 * DirectoryIterator::getATime() メソッドは、Unixタイムスタンプ形式で
8 * 最終アクセス時刻を返します。
9 *
10 * @param string $directoryPath 最終アクセス時刻を取得するディレクトリのパス。
11 *                              デフォルトは現在のディレクトリです。
12 * @return void
13 */
14function displayAccessTimesOfDirectoryEntries(string $directoryPath = '.'): void
15{
16    echo "ディレクトリ '{$directoryPath}' 内のエントリの最終アクセス時刻を表示します。\n\n";
17
18    try {
19        // DirectoryIterator を使用して、指定されたディレクトリの内容を反復処理します。
20        // これは、ファイルシステムのエントリを効率的に走査するための強力なツールです。
21        $iterator = new DirectoryIterator($directoryPath);
22
23        foreach ($iterator as $fileInfo) {
24            // '.' (カレントディレクトリ) と '..' (親ディレクトリ) はスキップします。
25            // これらは実際のファイルやディレクトリではないため、通常は除外します。
26            if ($fileInfo->isDot()) {
27                continue;
28            }
29
30            $fileName = $fileInfo->getFilename(); // エントリの名前を取得します。
31
32            // DirectoryIterator::getATime() を呼び出して、最終アクセス時刻を取得します。
33            // 戻り値はUnixタイムスタンプ（秒数）または失敗時に false です。
34            $accessTime = $fileInfo->getATime();
35
36            if ($accessTime !== false) {
37                // 取得したUnixタイムスタンプを人間が読める日付時刻形式に変換します。
38                // date() 関数は、タイムスタンプを任意のフォーマットに変換できます。
39                $formattedTime = date('Y-m-d H:i:s', $accessTime);
40                echo "エントリ: '{$fileName}' の最終アクセス時刻: {$formattedTime} (タイムスタンプ: {$accessTime})\n";
41            } else {
42                echo "エントリ: '{$fileName}' の最終アクセス時刻の取得に失敗しました。\n";
43            }
44        }
45    } catch (UnexpectedValueException $e) {
46        // ディレクトリが存在しない、アクセス権がないなどの場合に発生する例外を捕捉します。
47        echo "エラー: ディレクトリ '{$directoryPath}' を開くことができませんでした。\n";
48        echo "詳細: " . $e->getMessage() . "\n";
49    }
50}
51
52// スクリプトが実行されているカレントディレクトリの情報を表示します。
53// 例: displayAccessTimesOfDirectoryEntries('/path/to/your/directory'); のように、
54// 別のディレクトリパスを指定することも可能です。
55displayAccessTimesOfDirectoryEntries();
56
57?>

PHPのDirectoryIterator::getATime()メソッドは、ファイルやディレクトリが最後にアクセスされた時刻をUnixタイムスタンプ形式で取得するために使用されます。このメソッドは引数を取らずに呼び出され、処理が成功すると最終アクセス時刻を表す整数値のタイムスタンプを、失敗した場合にはfalseを返します。

サンプルコードでは、displayAccessTimesOfDirectoryEntries関数が指定されたディレクトリ内の各エントリ（ファイルやサブディレクトリ）の最終アクセス時刻を表示します。この関数は、DirectoryIteratorクラスを用いて指定ディレクトリの内容を効率的に反復処理し、ファイルシステムのエントリを一つずつ確認します。ループ内で各エントリに対しgetATime()メソッドを呼び出し、そのエントリの最終アクセス時刻をUnixタイムスタンプとして取得します。取得したタイムスタンプはdate()関数によって「年-月-日 時:分:秒」といった人間が読みやすい形式に変換され、エントリ名とともに画面に表示されます。もしタイムスタンプの取得に失敗した場合は、その旨が報告されます。また、指定されたディレクトリが存在しない、またはアクセス権がないといった問題が発生した際には、try-catchブロックでUnexpectedValueExceptionを捕捉し、適切なエラーメッセージを表示することで、スクリプトの安定性を高めています。このコードは、ファイルシステムのメタデータにアクセスし、情報を効果的に処理するPHPの基本的な方法を示しています。

Copy
1<?php
2
3// エラー報告を有効にし、すべてのエラーを表示します。
4// 開発環境でのデバッグに役立ちます。
5error_reporting(E_ALL);
6ini_set('display_errors', '1');
7
8/**
9 * 指定されたディレクトリ内の各ファイル/ディレクトリの最終アクセス時刻（ATime）を表示します。
10 *
11 * @param string $directoryPath 検索対象のディレクトリパス。デフォルトはカレントディレクトリ（'.'）。
12 * @return void
13 */
14function displayFileAccessTimes(string $directoryPath = '.')
15{
16    echo "--- ディレクトリ: '{$directoryPath}' 内のファイルの最終アクセス時刻 ---\n\n";
17
18    try {
19        // DirectoryIterator は、指定されたディレクトリ内のエントリ（ファイルやサブディレクトリ）を
20        // 簡単に反復処理するためのクラスです。
21        $iterator = new DirectoryIterator($directoryPath);
22
23        foreach ($iterator as $fileInfo) {
24            // '.' (カレントディレクトリ) と '..' (親ディレクトリ) は特殊なエントリなのでスキップします。
25            if ($fileInfo->isDot()) {
26                continue;
27            }
28
29            $fileName = $fileInfo->getFilename();
30            // getATime() メソッドは、ファイルまたはディレクトリの最終アクセス時刻を
31            // UNIXタイムスタンプ（1970年1月1日 00:00:00 UTC からの秒数）で返します。
32            // ファイルのアクセス（読み込みや実行など）によって更新されることがあります。
33            $accessTime = $fileInfo->getATime();
34
35            echo "ファイル/ディレクトリ名: {$fileName}\n";
36
37            if ($accessTime !== false) {
38                // UNIXタイムスタンプを「YYYY-MM-DD HH:MM:SS」形式の
39                // 人間が読みやすい日付と時刻に変換して表示します。
40                echo "  最終アクセス時刻: " . date('Y-m-d H:i:s', $accessTime) . "\n";
41            } else {
42                // getATime() が false を返した場合（例：アクセス権がない、ファイルが存在しないなど）。
43                echo "  最終アクセス時刻の取得に失敗しました。\n";
44            }
45            echo "\n";
46        }
47    } catch (UnexpectedValueException $e) {
48        // ディレクトリが見つからない、またはアクセス権がない場合に発生する例外をキャッチし、
49        // エラーメッセージを表示します。
50        echo "エラー: ディレクトリ '{$directoryPath}' を開けませんでした。\n";
51        echo "詳細: " . $e->getMessage() . "\n";
52    }
53}
54
55// 関数を実行し、現在のスクリプトがあるディレクトリのファイルアクセス時刻を表示します。
56// このスクリプトを実行する前に、同じディレクトリに適当なファイルを作成したり、
57// 既存のファイルを読み込んだりして、アクセス時刻がどのように表示されるか確認してみてください。
58displayFileAccessTimes();

PHP 8のDirectoryIterator::getATimeメソッドは、指定されたファイルやディレクトリの最終アクセス時刻を取得するために使用します。このメソッドはDirectoryIteratorクラスのインスタンスから呼び出され、ディレクトリ内の各エントリ（ファイルやサブディレクトリ）の詳細情報を扱う際に役立ちます。

getATimeメソッドは引数を必要としません。戻り値は通常、UNIXタイムスタンプと呼ばれる整数値（1970年1月1日 00:00:00 UTCからの秒数）です。このタイムスタンプは、ファイルが読み込まれたり、実行されたりといったアクセス操作によって更新されることがあります。もし何らかの理由で時刻の取得に失敗した場合（例えば、ファイルが存在しない、アクセス権がないなど）、戻り値はfalseとなります。

提供されたサンプルコードでは、DirectoryIteratorを使用して指定ディレクトリ内の各エントリを繰り返し処理し、getATime()メソッドでそれぞれの最終アクセス時刻を取得しています。取得したUNIXタイムスタンプは、date()関数を使って人間が読みやすい形式に変換され、表示されます。これにより、どのファイルやディレクトリがいつ最後にアクセスされたかを確認することができます。エラー発生時には適切なメッセージが表示されるよう配慮されています。