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

Copy
1<?php
2
3// SplFileInfo::getATime() メソッドの動作確認のため、一時ファイルを作成します。
4// このファイルへのアクセス時刻 (atime) を取得します。
5$tempFilePath = 'example_atime_file.txt';
6
7// ファイルが存在しない場合は作成し、最終アクセス時刻を記録するために内容を書き込みます。
8// この操作により、ファイルのアクセス時刻 (atime) が更新される可能性があります。
9if (file_put_contents($tempFilePath, 'This is a temporary file to demonstrate SplFileInfo::getATime().') === false) {
10    echo "エラー: 一時ファイルの作成に失敗しました。スクリプトを終了します。" . PHP_EOL;
11    exit(1);
12}
13
14// SplFileInfo クラスのインスタンスを作成します。
15// これにより、指定したファイルに関する様々な情報を取得できるようになります。
16$fileInfo = new SplFileInfo($tempFilePath);
17
18// getATime() メソッドを呼び出し、ファイルの最終アクセス時刻を取得します。
19// 戻り値はUNIXタイムスタンプ (整数) か、エラー時には false です。
20$accessTime = $fileInfo->getATime();
21
22// 取得した時刻が有効なUNIXタイムスタンプであるかを確認します。
23if ($accessTime !== false) {
24    echo "ファイル '{$tempFilePath}' の最終アクセス時刻情報:" . PHP_EOL;
25    // getATime() が返すのはUNIXタイムスタンプです。
26    // これは、1970年1月1日 00:00:00 UTC からの秒数で表されます。
27    echo "  UNIXタイムスタンプ: " . $accessTime . PHP_EOL;
28    // PHPの date() 関数を使って、UNIXタイムスタンプを人間が読める日付時刻形式に変換します。
29    echo "  人間が読める形式: " . date('Y-m-d H:i:s', $accessTime) . PHP_EOL;
30} else {
31    echo "エラー: ファイル '{$tempFilePath}' の最終アクセス時刻の取得に失敗しました。" . PHP_EOL;
32}
33
34// サンプルコード実行後、作成した一時ファイルを削除してクリーンアップします。
35if (file_exists($tempFilePath)) {
36    if (unlink($tempFilePath)) {
37        echo "一時ファイル '{$tempFilePath}' を削除しました。" . PHP_EOL;
38    } else {
39        echo "エラー: 一時ファイル '{$tempFilePath}' の削除に失敗しました。" . PHP_EOL;
40    }
41}
42
43?>

PHPのSplFileInfo::getATime()メソッドは、ファイルやディレクトリに関する詳細な情報を提供するSplFileInfoクラスに属します。このメソッドは、指定されたファイルの「最終アクセス時刻 (atime)」を取得するために利用されます。最終アクセス時刻とは、ファイルの内容が最後に読み込まれたり、実行されたりした日時を指します。

getATime()メソッドは引数を必要としません。戻り値としては、ファイルの最終アクセス時刻をUNIXタイムスタンプ形式の整数で返します。UNIXタイムスタンプは、1970年1月1日 00:00:00 UTCからの経過秒数を示す数値です。もしファイル情報の取得に失敗した場合や、ファイルが存在しない場合などには、falseが返されます。取得したUNIXタイムスタンプは、PHPのdate()関数などを用いることで、「YYYY-MM-DD HH:MM:SS」のような人間が読みやすい日付時刻形式に変換して表示できます。この機能は、ファイルの操作履歴を追跡したり、特定の条件に基づいてファイルを処理したりするシステム開発において、非常に重要な情報となります。

Copy
1<?php
2
3/**
4 * SplFileInfo::getATime() メソッドのサンプルコード
5 *
6 * このスクリプトは、一時ファイルを作成し、SplFileInfo クラスを使用して
7 * そのファイルの最終アクセス時刻（UNIXタイムスタンプ）を取得し、表示します。
8 * 初心者でも理解しやすいように、ファイルの作成から情報取得、クリーンアップまでの一連の流れを示します。
9 */
10
11// 1. 一時ファイルを作成するためのパスを準備します。
12// sys_get_temp_dir() はシステムのテンポラリディレクトリのパスを返します。
13// uniqid() は一意なIDを生成し、ファイル名の衝突を防ぎます。
14$tempFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'sample_file_' . uniqid() . '.txt';
15
16// 2. 実際に一時ファイルを作成し、ダミーの内容を書き込みます。
17// SplFileInfo は既存のファイルに対して動作するため、事前にファイルを作成しておく必要があります。
18if (file_put_contents($tempFilePath, 'このファイルはアクセス時刻をテストするために作成されました。') === false) {
19    echo "エラー: 一時ファイルの作成に失敗しました。\n";
20    exit(1); // スクリプトを終了
21}
22
23// 3. SplFileInfo クラスのインスタンスを作成します。
24// SplFileInfo は、ファイルやディレクトリに関する情報（名前、サイズ、パーミッション、時刻など）を
25// オブジェクト指向的に扱うためのPHP標準ライブラリ（SPL）のクラスです。
26$fileInfo = new SplFileInfo($tempFilePath);
27
28// 4. getATime() メソッドを呼び出し、ファイルの最終アクセス時刻を取得します。
29// getATime() は、ファイルが最後にアクセスされた時刻をUNIXタイムスタンプ（1970年1月1日 00:00:00 UTCからの秒数）で返します。
30// 取得に失敗した場合は false を返します。
31$accessTime = $fileInfo->getATime();
32
33// 5. 取得した時刻が有効であるかチェックし、結果を表示します。
34if ($accessTime !== false) {
35    echo "ファイル名: " . $fileInfo->getFilename() . "\n";
36    echo "最終アクセス時刻 (UNIXタイムスタンプ): " . $accessTime . "\n";
37
38    // UNIXタイムスタンプは人間には読みにくいため、date() 関数を使ってフォーマットします。
39    // 'Y-m-d H:i:s' は「年-月-日 時:分:秒」の形式です。
40    echo "最終アクセス時刻 (読みやすい形式): " . date('Y-m-d H:i:s', $accessTime) . "\n";
41} else {
42    echo "エラー: ファイルの最終アクセス時刻の取得に失敗しました。\n";
43}
44
45// 6. 使用した一時ファイルをクリーンアップ（削除）します。
46// サンプルスクリプトなので、作成したファイルは削除してシステムをきれいに保ちます。
47if (file_exists($tempFilePath)) {
48    unlink($tempFilePath); // ファイルを削除
49    echo "一時ファイル '" . basename($tempFilePath) . "' を削除しました。\n";
50}
51
52?>

SplFileInfo::getATime()メソッドは、PHPでファイルやディレクトリの情報をオブジェクト指向的に扱うためのSplFileInfoクラスに属し、指定されたファイルの最終アクセス時刻を取得します。このメソッドは引数を取りません。戻り値は、ファイルが最後にアクセスされた時刻をUNIXタイムスタンプ（1970年1月1日 00:00:00 UTCからの秒数）としてint型で返します。時刻の取得に失敗した場合はfalseを返しますので、必ず戻り値の確認が必要です。

このサンプルコードでは、まずシステムの一時ディレクトリに固有の名前で一時ファイルを作成し、ダミーの内容を書き込みます。SplFileInfoクラスは既存のファイルに対して情報を取得するため、事前のファイル作成が必須です。ファイルが用意されたら、そのパスを元にSplFileInfoオブジェクトを生成し、getATime()メソッドを呼び出して最終アクセス時刻を取得します。取得したUNIXタイムスタンプは、date()関数と組み合わせることで、「年-月-日 時:分:秒」のような人間が読みやすい形式に変換して表示できます。最後に、作成した一時ファイルを適切に削除し、システムをクリーンに保つ一連の流れを示しています。これにより、ファイルのアクセス時刻を扱う基本的な方法を習得できます。