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

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

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

作成日: 更新日:

基本的な使い方

getATimeメソッドは、特定のファイルやディレクトリが最後にアクセスされた日時を取得するメソッドです。このメソッドは、PHPの標準拡張機能として提供されるRecursiveDirectoryIteratorクラスの一部であり、ファイルシステムを再帰的に走査して、ディレクトリ内の各項目(ファイルやサブディレクトリ)に関する詳細情報を取得する際に利用されます。

「最終アクセス時刻」とは、ファイルの内容が読み込まれたり、ディレクトリの中身がリストアップされたりした、オペレーティングシステムが記録している最後の日時を指します。これは、ファイルの内容が変更された日時(最終更新時刻:mtime)や、ファイルのパーミッションなどが変更された日時(最終変更時刻:ctime)とは異なる情報です。ファイルを開いて内容を閲覧しただけでも、このアクセス時刻は更新される可能性があります。

このメソッドは、UNIXタイムスタンプ形式の整数値を返します。この数値は、1970年1月1日00:00:00 UTCからの経過秒数を表しており、PHPのdate()関数などと組み合わせることで、人間が読める形式の具体的な日付と時刻に変換して表示することができます。例えば、システムで長期間アクセスされていないファイルを特定して整理したり、特定のファイルが最後に利用された状況を追跡したりする際に役立ちます。ただし、ファイルシステムの種類やオペレーティングシステムの設定によっては、アクセス時刻の記録が有効になっていなかったり、正確に更新されなかったりする場合がある点には注意が必要です。

構文(syntax)

1<?php
2
3// 再帰的にディレクトリを走査するためのイテレータを作成します
4// '.' は現在のディレクトリを示します
5$path = './';
6$directoryIterator = new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS);
7$recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
8
9// 各ファイルまたはディレクトリを処理します
10foreach ($recursiveIterator as $fileInfo) {
11    // $fileInfo は RecursiveDirectoryIterator の要素であり、SplFileInfo オブジェクトです。
12    // その要素の最終アクセス時刻(UNIXタイムスタンプ形式)を取得します。
13    $accessTime = $fileInfo->getATime();
14
15    // 取得した時刻とファイル/ディレクトリのパスを表示する例
16    echo "Path: " . $fileInfo->getPathname() . ", Access Time: " . date('Y-m-d H:i:s', $accessTime) . "\n";
17}

引数(parameters)

引数なし

引数はありません

戻り値(return)

int|false

このメソッドは、ディレクトリに最後にアクセスした時刻をUNIXタイムスタンプ(秒単位)で返します。アクセス時刻の取得に失敗した場合は false を返します。

サンプルコード

PHP RecursiveDirectoryIteratorでファイルアクセス時刻を取得する

1<?php
2
3/**
4 * 指定されたディレクトリとその配下のファイル/ディレクトリの最終アクセス時刻(UNIXタイムスタンプ)を表示します。
5 * RecursiveDirectoryIterator の getATime() メソッドの使用例を示します。
6 *
7 * @param string $directoryPath 走査するディレクトリのパス。
8 * @return void
9 */
10function displayAccessTimes(string $directoryPath): void
11{
12    // 指定されたディレクトリが存在するか、アクセス可能かを確認
13    if (!is_dir($directoryPath) || !is_readable($directoryPath)) {
14        echo "エラー: ディレクトリ '{$directoryPath}' が存在しないか、アクセスできません。\n";
15        return;
16    }
17
18    echo "ディレクトリ '{$directoryPath}' およびその配下のアイテムのアクセス時刻:\n";
19    echo "-------------------------------------------------------------------\n";
20
21    try {
22        // RecursiveDirectoryIterator を使用してディレクトリツリーを走査します。
23        // SKIP_DOTS フラグは '.' と '..' エントリをスキップします。
24        $directoryIterator = new RecursiveDirectoryIterator(
25            $directoryPath,
26            RecursiveDirectoryIterator::SKIP_DOTS
27        );
28
29        // RecursiveIteratorIterator は、RecursiveDirectoryIterator と組み合わせて
30        // ディレクトリツリー全体(サブディレクトリを含む)を再帰的に走査するために使用します。
31        // SELF_FIRST は、ディレクトリ自体をその内容の前に処理することを意味します。
32        $iterator = new RecursiveIteratorIterator(
33            $directoryIterator,
34            RecursiveIteratorIterator::SELF_FIRST
35        );
36
37        foreach ($iterator as $fileInfo) {
38            // SplFileInfo オブジェクトから最終アクセス時刻のUNIXタイムスタンプを取得します。
39            // 戻り値は int(タイムスタンプ)または false(取得失敗)です。
40            $accessTime = $fileInfo->getATime();
41
42            // タイムスタンプが正常に取得できたかを確認します。
43            if ($accessTime !== false) {
44                // UNIXタイムスタンプを人間が読める形式に変換します。
45                $formattedTime = date('Y-m-d H:i:s', $accessTime);
46
47                // アイテムがファイルかディレクトリかに応じて表示を調整します。
48                $type = $fileInfo->isFile() ? 'ファイル' : ($fileInfo->isDir() ? 'ディレクトリ' : '不明');
49
50                printf("  [%s] %s: %s\n", $type, $fileInfo->getPathname(), $formattedTime);
51            } else {
52                printf("  [%s] %s: アクセス時刻の取得に失敗しました。\n", $fileInfo->isFile() ? 'ファイル' : 'ディレクトリ', $fileInfo->getPathname());
53            }
54        }
55    } catch (UnexpectedValueException $e) {
56        // 無効なパスが指定された場合などに発生する可能性のある例外を捕捉します。
57        echo "エラー: ディレクトリの走査中に問題が発生しました - " . $e->getMessage() . "\n";
58    } catch (RuntimeException $e) {
59        // その他のランタイムエラーを捕捉します。
60        echo "エラー: ランタイムエラーが発生しました - " . $e->getMessage() . "\n";
61    }
62}
63
64// スクリプトが実行されているカレントディレクトリを対象とします。
65// テストのために一時ファイルやディレクトリを作成して試すこともできます。
66// 例: mkdir('test_dir'); touch('test_dir/file.txt');
67$targetDirectory = __DIR__;
68
69// 関数を実行して結果を表示します。
70displayAccessTimes($targetDirectory);
71
72?>

このPHPのサンプルコードは、RecursiveDirectoryIteratorクラスのgetATime()メソッドを使って、指定されたディレクトリとその配下にあるファイルやディレクトリの最終アクセス時刻を表示する方法を示しています。

getATime()メソッドは、引数なしで呼び出され、ファイルやディレクトリが最後にアクセスされた時刻をUNIXタイムスタンプ(整数値)として返します。ただし、何らかの理由で時刻の取得に失敗した場合はfalseが戻り値となります。

コードでは、まずRecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせて、対象ディレクトリ内のすべてのファイルやサブディレクトリを再帰的に走査しています。ループ内で各アイテムに対しgetATime()を呼び出し、その戻り値を確認します。タイムスタンプが正常に取得できた場合は、date()関数を使って人間が読める形式(例: 'YYYY-MM-DD HH:i:s')に変換して出力します。もしfalseが返された場合は、アクセス時刻の取得に失敗した旨を表示し、エラーハンドリングの重要性も示しています。これにより、PHPでファイルシステムの情報を扱い、アクセス時刻を取得する基本的な流れを学ぶことができます。

getATime()メソッドは、ファイルやディレクトリの最終アクセス時刻をUNIXタイムスタンプ(整数値)で返しますが、取得に失敗した場合はfalseを返します。このfalseが返される可能性を考慮し、必ず!== falseで厳密にチェックし、適切にエラー処理を行うことが重要です。戻り値のUNIXタイムスタンプは、date()関数などを利用して人間が読める形式に変換してください。

また、アクセス時刻(atime)は、ファイルシステムの種類やOSの設定、マウントオプションによっては更新されない場合や、更新の精度が低い場合があります。特にシステム環境依存性が高いため、意図した通りに動作しない可能性も考慮に入れてください。ディレクトリへのアクセス権限が不足している場合も取得に失敗することがあります。コードの安定性のため、try-catchブロックによる例外処理も適切に組み込むことを推奨します。

PHP RecursiveDirectoryIterator getATime を取得する

1<?php
2
3/**
4 * 指定されたディレクトリツリー内の各ファイルとディレクトリの
5 * 最終アクセス時刻 (ATime) を表示します。
6 *
7 * この関数は、RecursiveDirectoryIterator を使用してディレクトリを再帰的に走査し、
8 * 各要素の SplFileInfo::getATime() メソッドで最終アクセス時刻を取得します。
9 * getATime() は UNIX タイムスタンプ (int) または取得失敗時 (false) を返します。
10 *
11 * @param string $directoryPath 走査するディレクトリのパス
12 */
13function showFileAccessTimes(string $directoryPath): void
14{
15    try {
16        // RecursiveDirectoryIterator を初期化し、ディレクトリを再帰的に走査します。
17        // RecursiveDirectoryIterator::SKIP_DOTS フラグで特殊ディレクトリ '.' と '..' をスキップします。
18        $directoryIterator = new RecursiveDirectoryIterator(
19            $directoryPath,
20            RecursiveDirectoryIterator::SKIP_DOTS
21        );
22
23        // RecursiveIteratorIterator を使用して、再帰的な反復処理を容易にします。
24        // RecursiveIteratorIterator::SELF_FIRST はディレクトリ自身も対象に含めます。
25        $iterator = new RecursiveIteratorIterator(
26            $directoryIterator,
27            RecursiveIteratorIterator::SELF_FIRST
28        );
29
30        echo "ディレクトリツリー内の最終アクセス時刻:\n";
31        echo "--------------------------------------\n";
32
33        // 各ファイルまたはディレクトリを反復処理します。
34        foreach ($iterator as $fileInfo) {
35            // SplFileInfo::getATime() メソッドで最終アクセス時刻(UNIXタイムスタンプ)を取得します。
36            $accessTime = $fileInfo->getATime();
37
38            if ($accessTime !== false) {
39                // タイムスタンプを人間が読める日付形式に変換して表示します。
40                $formattedTime = date('Y-m-d H:i:s', $accessTime);
41                printf("%s: %s\n", $fileInfo->getPathname(), $formattedTime);
42            } else {
43                // アクセス時刻の取得に失敗した場合のメッセージ。
44                printf("%s: アクセス時刻の取得に失敗しました。\n", $fileInfo->getPathname());
45            }
46        }
47        echo "--------------------------------------\n";
48
49    } catch (UnexpectedValueException $e) {
50        // 指定されたパスがディレクトリでない、存在しない、またはアクセス権がない場合に発生するエラー。
51        echo "エラー: ディレクトリ「{$directoryPath}」にアクセスできません。" . $e->getMessage() . "\n";
52    } catch (Throwable $e) {
53        // その他の予期せぬエラーを処理します (PHP 7 以降で Exception と Error を両方捕捉)。
54        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
55    }
56}
57
58// スクリプトが実行されている現在のディレクトリを対象とします。
59// このスクリプトがあるディレクトリとそのサブディレクトリ内の
60// ファイルやディレクトリの最終アクセス時刻が表示されます。
61showFileAccessTimes(__DIR__);

このPHPコードは、指定されたディレクトリとそのサブディレクトリにある、すべてのファイルやディレクトリの「最終アクセス時刻(ATime)」を一覧表示するものです。

コードでは、RecursiveDirectoryIteratorとRecursiveIteratorIteratorという機能を使って、指定されたディレクトリの階層構造(ディレクトリツリー)を効率的に再帰的にたどります。それぞれのファイルやディレクトリはSplFileInfoオブジェクトとして扱われ、そのオブジェクトのgetATime()メソッドを呼び出すことで最終アクセス時刻を取得しています。

getATime()メソッドは引数を必要とせず、対象のファイルやディレクトリが最後に読み込まれたり、実行されたりした日時をUNIXタイムスタンプという数値形式(int)で返します。しかし、何らかの理由で時刻の取得に失敗した場合はfalseが返されます。サンプルコードでは、この戻り値がfalseでないことを確認した上で、取得したUNIXタイムスタンプをdate()関数で「年-月-日 時:分:秒」といった人間が読みやすい形式に変換し、それぞれのパスと共に出力しています。

このようにして、指定したディレクトリツリー内で、どのファイルやディレクトリがいつ最後にアクセスされたかを簡単に確認できます。

PHPのgetATime()メソッドは、ファイルへの最終アクセス時刻をUNIXタイムスタンプ(int)で返しますが、情報が取得できなかった場合はfalseを返します。そのため、必ず戻り値がfalseでないかを確認し、適切なエラーハンドリングを行う必要があります。取得したタイムスタンプは、date()関数などを使って人間が読める形式に変換してください。また、OSやファイルシステムの仕様によっては、アクセス時刻(ATime)の更新が無効化されている場合があり、常に最新の時刻が得られるとは限りません。さらに、指定されたディレクトリパスが存在しない、またはアクセス権がない場合には、UnexpectedValueExceptionが発生するため、try-catchブロックによる例外処理が必須です。

関連コンテンツ

関連IT用語

関連プログラミング言語