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

Copy
1<?php
2
3// このコードは、PHPのFilesystemIterator::getATime() メソッドの
4// 使用方法を示すサンプルです。
5// ファイルの最終アクセス時刻をUnixタイムスタンプとして取得し、
6// それを人間が読める形式に変換する方法を実演します。
7
8// 1. サンプル実行のための一時ディレクトリとファイルを作成します。
9$tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('php_filesystem_example_');
10$tempFile = $tempDir . DIRECTORY_SEPARATOR . 'sample_file.txt';
11
12try {
13    // 一時ディレクトリが存在しない場合は作成します。
14    if (!mkdir($tempDir, 0777, true)) {
15        throw new RuntimeException("一時ディレクトリの作成に失敗しました: " . $tempDir);
16    }
17
18    // テスト用のファイルを作成します。
19    // ファイルの作成や書き込み操作は、そのファイルのアクセス時刻 (ATime) を更新する場合があります。
20    if (file_put_contents($tempFile, "これはFilesystemIterator::getATime() のテストファイルです。\n") === false) {
21        throw new RuntimeException("一時ファイルの作成に失敗しました: " . $tempFile);
22    }
23    
24    // オプション: ファイルの内容を一度読み込むことで、アクセス時刻が確実に更新されるようにします。
25    // OSによっては、file_put_contents() だけではアクセス時刻が更新されない場合があります。
26    file_get_contents($tempFile);
27
28    echo "一時ファイルを作成しました: {$tempFile}\n";
29    echo "FilesystemIterator を使用してファイル情報を取得します。\n\n";
30
31    // 2. FilesystemIterator のインスタンスを作成します。
32    // これにより、指定したディレクトリ内のファイルやサブディレクトリを簡単に反復処理できます。
33    // SKIP_DOTS: "." および ".." (現在のディレクトリと親ディレクトリ) エントリをスキップします。
34    // CURRENT_AS_FILEINFO: イテレータが SplFileInfo オブジェクト（ファイル情報オブジェクト）を返します。
35    $iterator = new FilesystemIterator(
36        $tempDir,
37        FilesystemIterator::SKIP_DOTS | FilesystemIterator::CURRENT_AS_FILEINFO
38    );
39
40    // 3. ディレクトリ内の各項目をイテレートし、getATime() メソッドでアクセス時刻を取得します。
41    foreach ($iterator as $fileInfo) {
42        // 現在の項目がファイルであることを確認し、その情報を処理します。
43        // getATime() はディレクトリに対しても機能しますが、ここではファイルの例に焦点を当てます。
44        if ($fileInfo->isFile()) {
45            $fileName = $fileInfo->getFilename();
46
47            // FilesystemIterator::getATime() を呼び出して、
48            // ファイルの最終アクセス時刻をUnixタイムスタンプ（協定世界時からの秒数を示す整数値）で取得します。
49            $accessTimeUnixTimestamp = $fileInfo->getATime();
50
51            // 取得したUnixタイムスタンプを人間が読める「年-月-日 時:分:秒」形式の日付文字列に変換します。
52            $formattedAccessTime = date('Y-m-d H:i:s', $accessTimeUnixTimestamp);
53
54            echo "ファイル名: {$fileName}\n";
55            echo "最終アクセス時刻 (Unixタイムスタンプ): {$accessTimeUnixTimestamp}\n";
56            echo "最終アクセス時刻 (読みやすい形式): {$formattedAccessTime}\n\n";
57        }
58    }
59
60} catch (RuntimeException $e) {
61    // 処理中に発生したエラーメッセージを出力します。
62    echo "エラーが発生しました: " . $e->getMessage() . "\n";
63} finally {
64    // 4. サンプルコードの実行後に、作成した一時リソースをクリーンアップします。
65    // これにより、不要なファイルやディレクトリがシステムに残るのを防ぎます。
66    if (file_exists($tempFile)) {
67        unlink($tempFile); // 一時ファイルを削除
68    }
69    // ディレクトリが空であることを確認してから削除します。
70    // scandir() で "." と ".." 以外のファイルがないことを確認しています。
71    if (is_dir($tempDir) && empty(array_diff(scandir($tempDir), ['.', '..']))) {
72        rmdir($tempDir); // 一時ディレクトリを削除
73    }
74    echo "一時リソースをクリーンアップしました。\n";
75}

このコードは、PHP 8で提供されるFilesystemIteratorクラスのgetATime()メソッドの利用方法を実演します。getATime()メソッドは、特定のファイルの最終アクセス時刻をUnixタイムスタンプとして取得するために使用されます。このメソッドは引数を必要とせず、整数値（int）としてUnixタイムスタンプを返します。Unixタイムスタンプとは、1970年1月1日 00:00:00 UTCからの経過秒数を示す数値です。

サンプルでは、一時的なディレクトリとファイルを作成し、そのファイルに対してFilesystemIteratorを使用して情報にアクセスします。FilesystemIteratorはディレクトリ内のファイルやサブディレクトリを効率的に反復処理するためのクラスで、各項目はSplFileInfoオブジェクトとして扱われます。このSplFileInfoオブジェクトを通じてgetATime()を呼び出すことで、ファイルの最終アクセス時刻が取得できます。取得されたUnixタイムスタンプは、PHPのdate()関数と組み合わせることで「年-月-日 時:分:秒」のような人間が読みやすい形式の日付文字列に変換し、表示されます。コードの実行後には、作成した一時リソースが確実にクリーンアップされます。

Copy
1<?php
2
3// このスクリプトが実行される一時ディレクトリを取得します。
4$tempDir = sys_get_temp_dir();
5// 重複しない一時ファイル名を生成します。
6$tempFileName = 'php_getatime_example_' . uniqid() . '.txt';
7$tempFilePath = $tempDir . DIRECTORY_SEPARATOR . $tempFileName;
8
9// テスト用の一時ファイルを作成し、内容を書き込みます。
10// これにより、ファイルが存在する状態になります。
11file_put_contents($tempFilePath, 'This is a test file for FilesystemIterator::getATime example.');
12
13// ファイルのアクセス時刻 (ATime) を更新するため、ファイルの内容を読み込みます。
14// getATime() メソッドはファイルの最終アクセス時刻を返すため、アクセス操作が必要です。
15file_get_contents($tempFilePath);
16
17// FilesystemIterator を使用して指定されたディレクトリ内のファイルやディレクトリを走査します。
18// FilesystemIterator::SKIP_DOTS は、'.' (カレントディレクトリ) と '..' (親ディレクトリ) の特殊エントリをスキップします。
19// FilesystemIterator::CURRENT_AS_FILEINFO は、イテレータが返す値が SplFileInfo オブジェクトであることを保証します。
20$iterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS | FilesystemIterator::CURRENT_AS_FILEINFO);
21
22echo "--- ファイルの最終アクセス時刻 (ATime) ---" . PHP_EOL;
23
24// イテレータをループし、各ファイル（SplFileInfoオブジェクト）について処理します。
25foreach ($iterator as $fileInfo) {
26    // 作成した一時ファイルに該当する場合のみ情報を表示します。
27    if ($fileInfo->getFilename() === $tempFileName) {
28        // FilesystemIterator が現在指すファイルの最終アクセス時刻をUnixタイムスタンプで取得します。
29        // この getATime() メソッドは SplFileInfo クラスに属し、FilesystemIterator からアクセスできるファイル情報に適用されます。
30        $accessTimeUnix = $fileInfo->getATime();
31
32        // Unixタイムスタンプを人間が読みやすい形式 (YYYY-MM-DD HH:MM:SS) に変換します。
33        $accessTimeFormatted = date('Y-m-d H:i:s', $accessTimeUnix);
34
35        echo "ファイル名: " . $fileInfo->getFilename() . PHP_EOL;
36        echo "最終アクセス時刻 (Unixタイムスタンプ): " . $accessTimeUnix . PHP_EOL;
37        echo "最終アクセス時刻 (フォーマット済み): " . $accessTimeFormatted . PHP_EOL;
38        echo PHP_EOL;
39        
40        // 目的のファイルが見つかったので、これ以上の走査は不要です。
41        break; 
42    }
43}
44
45// サンプルコード実行後、作成した一時ファイルを削除してクリーンアップします。
46if (file_exists($tempFilePath)) {
47    unlink($tempFilePath);
48}

PHP 8で利用可能なgetATimeメソッドは、ファイルやディレクトリの最終アクセス時刻（Last Access Time）を取得するために使われる重要な機能です。このメソッドはSplFileInfoクラスに属しており、FilesystemIteratorなどを用いてファイルシステムを走査する際に得られる各ファイルの情報を保持するオブジェクト（SplFileInfoインスタンス）から呼び出すことができます。

getATimeメソッドは引数を必要とせず、戻り値として整数（int）を返します。この整数はUnixタイムスタンプ形式であり、1970年1月1日 00:00:00 UTCからの経過秒数を示します。これにより、ファイルが最後に読み込まれたり、変更されたりした時刻を正確に把握することが可能です。

提供されたサンプルコードでは、まず一時ファイルを準備し、そのファイルにアクセス操作を加えることで最終アクセス時刻を更新しています。その後、FilesystemIteratorを使用してディレクトリを走査し、目的のファイルを見つけ出します。見つかったファイルのSplFileInfoオブジェクトに対してgetATimeを呼び出すことで、更新された最終アクセス時刻をUnixタイムスタンプとして取得し、さらにdate関数を使って人間が読みやすい形式に変換して表示しています。この機能は、ファイルの利用状況を監視したり、古いファイルを特定したりする際に大変役立ちます。