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

Copy
1<?php
2
3// テスト用の一時ファイル名を設定します
4$testFileName = 'example_access_time.txt';
5
6try {
7    // 1. サンプルコードの動作確認のために一時ファイルを作成します
8    // file_put_contents はファイルが存在しない場合は作成し、存在する場合は上書きします
9    file_put_contents($testFileName, 'このファイルはGlobIterator::getATimeのサンプルコード用です。');
10    echo "一時ファイル '{$testFileName}' を作成しました。\n";
11
12    // 2. ファイルを読み込むことで、ファイルの最終アクセス時刻（atime）を更新します
13    // ただし、OSやファイルシステムの設定によってはatimeがすぐに更新されない場合もあります
14    // (例: Linuxでmountオプションに 'noatime' や 'relatime' が指定されている場合など)。
15    file_get_contents($testFileName);
16    echo "一時ファイル '{$testFileName}' を読み込みました。\n";
17
18    // アクセス時刻の更新がシステムに反映されるのを待つため、わずかに遅延させます
19    sleep(1);
20
21    // 3. GlobIterator を使用して、指定されたパターンに一致するファイルを探します
22    // ここでは、作成した一時ファイルをパターンとして指定しています
23    $iterator = new GlobIterator($testFileName);
24
25    echo "\n--- ファイルのアクセス時刻を取得する例 ---\n";
26
27    // イテレータが有効な（ファイルが見つかった）場合のみ処理を進めます
28    if ($iterator->valid()) {
29        // GlobIterator はイテレーションの際に SplFileInfo オブジェクトを返します
30        foreach ($iterator as $fileInfo) {
31            // SplFileInfo::getATime() メソッドで、ファイルの最終アクセス時刻のUnixタイムスタンプを取得します
32            // このタイムスタンプは、ファイルが最後にアクセス（読み込まれたり、実行されたり）された日時を示します
33            $accessTime = $fileInfo->getATime();
34
35            echo "ファイル名: " . $fileInfo->getFilename() . "\n";
36            echo "アクセス時刻 (Unixタイムスタンプ): " . $accessTime . "\n";
37            // Unixタイムスタンプを人間が読みやすい「年-月-日 時:分:秒」形式に変換して表示します
38            echo "アクセス時刻 (可読形式): " . date('Y-m-d H:i:s', $accessTime) . "\n\n";
39        }
40    } else {
41        echo "指定されたパターンに一致するファイルが見つかりませんでした。\n";
42    }
43
44} catch (Exception $e) {
45    // 例外が発生した場合、エラーメッセージを表示します
46    echo "エラーが発生しました: " . $e->getMessage() . "\n";
47} finally {
48    // 4. 後処理として、作成した一時ファイルを削除します
49    if (file_exists($testFileName)) {
50        unlink($testFileName); // unlink() でファイルを削除
51        echo "一時ファイル '{$testFileName}' を削除しました。\n";
52    }
53}

PHPのGlobIterator::getATimeメソッドは、ファイルシステム上のファイルの最終アクセス時刻（atime）をUnixタイムスタンプ形式で取得するために使用されます。このメソッドはGlobIteratorクラスがファイルを反復処理する際に生成するSplFileInfoオブジェクトに対して呼び出されます。引数は必要なく、戻り値は整数値（int）で、1970年1月1日00:00:00 UTCからの秒数を示すUnixタイムスタンプを返します。

このサンプルコードでは、まず一時ファイルを作成し、そのファイルを読み込むことでファイルの最終アクセス時刻を意図的に更新しています。その後、GlobIteratorを使って指定したファイルパスに一致するファイルを見つけ、取得したSplFileInfoオブジェクトからgetATimeメソッドを呼び出してアクセス時刻のUnixタイムスタンプを取得しています。取得されたタイムスタンプは、date()関数と組み合わせることで「年-月-日 時:分:秒」のような人間が読みやすい形式に変換して表示できます。php gettimestampというキーワードに関連して、ファイルが最後にアクセスされた日時を知りたい場合にこのメソッドが役立ち、ファイルの状態をプログラムで管理する上で重要な情報の一つとなります。

Copy
1<?php
2
3/**
4 * デモンストレーション用に一時ファイルを作成するヘルパー関数です。
5 */
6function createTemporaryFiles(string $directory, array $filenames): void
7{
8    if (!is_dir($directory) && !mkdir($directory, 0777, true)) {
9        throw new RuntimeException(sprintf('ディレクトリ "%s" の作成に失敗しました。', $directory));
10    }
11    foreach ($filenames as $filename) {
12        $filePath = $directory . '/' . $filename;
13        file_put_contents($filePath, 'Test content for ' . $filename);
14        // ファイルにアクセスすることで、最終アクセス時刻が記録されます。
15        // 注意: 一部のファイルシステム設定では、アクセス時刻の更新が無効になっている場合があります。
16        file_get_contents($filePath);
17    }
18}
19
20/**
21 * デモンストレーション後に作成した一時ファイルを削除するヘルパー関数です。
22 */
23function cleanupTemporaryFiles(string $directory): void
24{
25    if (is_dir($directory)) {
26        foreach (new FilesystemIterator($directory) as $file) {
27            unlink($file->getPathname());
28        }
29        rmdir($directory);
30    }
31}
32
33/**
34 * GlobIterator を使用してファイルの最終アクセス時刻 (getATime) を取得する方法を示します。
35 *
36 * GlobIterator は、指定されたパターンに一致するファイルを反復処理するためのイテレータです。
37 * 反復処理中に得られる各ファイルの情報は SplFileInfo オブジェクトとして提供され、
38 * getATime() メソッドはその SplFileInfo オブジェクトのメソッドです。
39 */
40function demonstrateGlobIteratorGetATime(): void
41{
42    $tempDir = __DIR__ . '/temp_glob_demo';
43    $filenames = ['document1.txt', 'photo.jpg', 'report.pdf'];
44
45    try {
46        // デモンストレーション用に一時ファイルを作成します。
47        createTemporaryFiles($tempDir, $filenames);
48
49        echo "--- ファイルの最終アクセス時刻 (getATime) の表示 ---\n";
50
51        // GlobIterator をインスタンス化し、指定されたパターンに一致するファイルを検索します。
52        // ここでは 'temp_glob_demo/*' で、作成した全ての一時ファイルを対象とします。
53        $iterator = new GlobIterator($tempDir . '/*');
54
55        // 見つかったファイルがない場合はメッセージを表示します。
56        if (!$iterator->valid()) {
57            echo "指定されたパターン '{$tempDir}/*' に一致するファイルが見つかりませんでした。\n";
58        } else {
59            // 見つかったファイルを反復処理します。
60            foreach ($iterator as $fileInfo) {
61                // $fileInfo は SplFileInfo オブジェクトです。
62                // getATime() メソッドは、ファイルの最終アクセス時刻をUNIXタイムスタンプ（整数値）で返します。
63                $accessTime = $fileInfo->getATime();
64                // UNIXタイムスタンプを人間が読みやすい形式に変換します。
65                $formattedTime = date('Y-m-d H:i:s', $accessTime);
66
67                echo sprintf(
68                    "ファイル名: %s, 最終アクセス時刻: %s (UNIXタイムスタンプ: %d)\n",
69                    $fileInfo->getFilename(),
70                    $formattedTime,
71                    $accessTime
72                );
73            }
74        }
75    } catch (RuntimeException $e) {
76        echo "エラーが発生しました: " . $e->getMessage() . "\n";
77    } finally {
78        // 使用した一時ファイルをクリーンアップします。
79        cleanupTemporaryFiles($tempDir);
80        echo "\n一時ファイルをクリーンアップしました。\n";
81    }
82}
83
84// デモンストレーション関数の実行
85demonstrateGlobIteratorGetATime();

PHP 8のGlobIterator::getATimeメソッドは、ファイルやディレクトリの情報を取得するSplFileInfoクラスのメソッドとして提供されます。このメソッドは、指定されたファイルの最終アクセス時刻をUNIXタイムスタンプ形式の整数値で取得します。引数はなく、アクセス時刻を秒単位で表す整数値が戻り値として返されます。

このサンプルコードでは、まずデモンストレーション用にいくつか一時ファイルを作成しています。その後、GlobIteratorをインスタンス化し、temp_glob_demo/*というパターンで一時ディレクトリ内のすべてのファイルを探索します。GlobIteratorは、foreachループで反復処理される際に、各ファイルに関する詳細情報を持つSplFileInfoオブジェクトを一つずつ返します。

ループ内で得られたSplFileInfoオブジェクトに対してgetATime()メソッドを呼び出すことで、そのファイルの最終アクセス時刻をUNIXタイムスタンプとして取得します。このタイムスタンプは通常、date()関数と組み合わせてYYYY-MM-DD HH:MM:SSのような、人間が読みやすい日付と時刻の形式に変換して利用されます。最終アクセス時刻の記録はファイルシステムの設定に依存するため、すべての環境で期待通りに更新されるとは限らない点にご留意ください。デモンストレーションの終了後には、作成した一時ファイルが適切に削除されます。