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

Copy
1<?php
2
3/**
4 * SplFileObject::getCTime() の使用例を示す関数です。
5 * このメソッドは、ファイルの最終 inode 変更時刻 (UNIXタイムスタンプ) を取得します。
6 *
7 * @return void
8 */
9function demonstrateSplFileObjectGetCTime(): void
10{
11    // 1. デモンストレーション用の一時ファイルを作成します。
12    $tempFileName = 'example_file_for_ctime.txt';
13    $fileContent = 'これはSplFileObject::getCTime()の動作確認用の一時ファイルです。';
14
15    // ファイルにコンテンツを書き込み、作成に失敗した場合は処理を終了します。
16    if (file_put_contents($tempFileName, $fileContent) === false) {
17        echo "エラー: 一時ファイル '{$tempFileName}' の作成に失敗しました。\n";
18        return;
19    }
20
21    echo "一時ファイル '{$tempFileName}' を作成しました。\n";
22
23    try {
24        // 2. SplFileObject のインスタンスを作成します。
25        // 'r' モードでファイルを読み込み用に開きます。
26        $fileObject = new SplFileObject($tempFileName, 'r');
27
28        // 3. getCTime() メソッドを呼び出し、ファイルの最終 inode 変更時刻を取得します。
29        // 戻り値は UNIX タイムスタンプ形式の整数、または失敗した場合は false です。
30        $cTime = $fileObject->getCTime();
31
32        if ($cTime !== false) {
33            echo "ファイル '{$tempFileName}' の最終 inode 変更時刻 (UNIXタイムスタンプ): " . $cTime . "\n";
34            // 取得したタイムスタンプを date() 関数で人間が読める形式に変換します。
35            echo "人間が読める形式: " . date('Y-m-d H:i:s', $cTime) . "\n";
36        } else {
37            // SplFileObject が正常に作成されている場合、getCTime() は通常 false を返しません。
38            // しかし、万が一の場合に備えてエラーメッセージを表示します。
39            echo "エラー: ファイル '{$tempFileName}' の最終 inode 変更時刻の取得に失敗しました。\n";
40        }
41    } catch (RuntimeException $e) {
42        // SplFileObject のコンストラクタでエラーが発生した場合 (例: ファイルが存在しない、アクセス権がない) の処理です。
43        echo "エラー: SplFileObject の作成に失敗しました - " . $e->getMessage() . "\n";
44    } finally {
45        // 4. 作成した一時ファイルを削除します。
46        // file_exists() でファイルが存在することを確認してから削除することが推奨されます。
47        if (file_exists($tempFileName)) {
48            unlink($tempFileName);
49            echo "一時ファイル '{$tempFileName}' を削除しました。\n";
50        }
51    }
52}
53
54// 関数を実行して、SplFileObject::getCTime() の動作を確認します。
55demonstrateSplFileObjectGetCTime();

PHP 8のSplFileObject::getCTime()メソッドは、ファイルシステム上のファイルの最終inode変更時刻を取得するために使用されます。この「inode変更時刻」とは、ファイルのデータ内容だけでなく、ファイルのアクセス権限や所有者といったメタデータが変更された場合にも更新される時刻を指します。このメソッドは引数を必要とせず、呼び出しに成功するとUNIXタイムスタンプ形式の整数（1970年1月1日 00:00:00 UTCからの経過秒数）を返し、失敗した場合はfalseを返します。

サンプルコードでは、まず一時的なテキストファイルを作成し、SplFileObjectクラスのインスタンスとしてそのファイルを開きます。その後、$fileObject->getCTime()を呼び出すことで、作成した一時ファイルの最終inode変更時刻を取得します。取得されたUNIXタイムスタンプは、date()関数と組み合わせることで、「年-月-日 時:分:秒」のような、人間が読める形式に変換して表示されます。また、ファイル作成の失敗やSplFileObjectのインスタンス生成時のエラー、そして一時ファイルの削除処理など、安全なコード運用に必要な考慮事項も示されており、ファイルのメタデータ管理におけるこのメソッドの具体的な利用方法を理解するのに役立ちます。

Copy
1<?php
2
3/**
4 * SplFileObject::getCTime メソッドの使用例。
5 *
6 * この関数は、一時ファイルを作成し、そのファイルの最終 inode 変更時刻 (ctime) を取得します。
7 * ctime は、ファイルのパーミッション、所有者、またはファイルの内容が変更された際に更新されます。
8 */
9function demonstrateSplFileObjectGetCTime(): void
10{
11    // 一時ファイルを作成し、内容を書き込む準備をします。
12    // sys_get_temp_dir() でシステムの一時ディレクトリパスを取得します。
13    // 'php_ctime_test_' は一時ファイル名のプレフィックスです。
14    $tempFile = tempnam(sys_get_temp_dir(), 'php_ctime_test_');
15
16    // 一時ファイルの作成に失敗した場合の処理
17    if ($tempFile === false) {
18        echo "エラー: 一時ファイルの作成に失敗しました。\n";
19        return;
20    }
21
22    // 作成した一時ファイルにダミーの内容を書き込みます。
23    // これにより、ファイルが存在し、内容が変更された状態になります。
24    if (file_put_contents($tempFile, "これは SplFileObject::getCTime のテストファイルです。\n") === false) {
25        echo "エラー: 一時ファイルへの書き込みに失敗しました。\n";
26        unlink($tempFile); // 失敗した場合でもクリーンアップを試みます
27        return;
28    }
29
30    echo "一時ファイルを作成しました: " . $tempFile . "\n";
31
32    try {
33        // 作成した一時ファイルパスを使用して SplFileObject のインスタンスを作成します。
34        // これにより、ファイルへのオブジェクト指向的なアクセスが可能になります。
35        $fileObject = new SplFileObject($tempFile);
36
37        // getCTime メソッドを呼び出し、ファイルの最終 inode 変更時刻を取得します。
38        // 戻り値は UNIX タイムスタンプ (整数) または失敗時に false です。
39        $ctime = $fileObject->getCTime();
40
41        if ($ctime !== false) {
42            echo "ファイルの最終 inode 変更時刻 (UNIXタイムスタンプ): " . $ctime . "\n";
43            // UNIXタイムスタンプを人間が読める形式に変換して表示します。
44            echo "人間が読める形式: " . date('Y-m-d H:i:s', $ctime) . "\n";
45        } else {
46            // getCTime が false を返した場合、時刻の取得に失敗したことを示します。
47            echo "エラー: ファイルの最終 inode 変更時刻の取得に失敗しました。\n";
48        }
49    } catch (RuntimeException $e) {
50        // SplFileObject のコンストラクタでエラーが発生した場合（例: ファイルが存在しない、権限がないなど）
51        echo "SplFileObject の操作中にエラーが発生しました: " . $e->getMessage() . "\n";
52    } finally {
53        // プログラム終了前に作成した一時ファイルを削除し、システムをクリーンアップします。
54        if (file_exists($tempFile)) {
55            unlink($tempFile);
56            echo "一時ファイル " . $tempFile . " を削除しました。\n";
57        }
58    }
59}
60
61// 関数を実行し、SplFileObject::getCTime の動作を示します。
62demonstrateSplFileObjectGetCTime();
63
64?>

SplFileObject::getCTimeメソッドは、PHPでファイル操作を行う際に、ファイルの「最終 inode 変更時刻」（ctime）を取得するために使用されます。ctimeとは、ファイルのパーミッション（アクセス権限）、所有者、またはファイルの内容そのものが変更された際に更新される時刻を指します。

このメソッドは引数を一切取りません。戻り値は、時刻の取得に成功した場合はUNIXタイムスタンプ形式の整数（int）で時刻を返し、取得に失敗した場合はfalseを返します。

サンプルコードでは、まずシステムの一時ディレクトリにダミーの一時ファイルを作成し、簡単なテキスト内容を書き込みます。これは、ファイルが存在し、内容が変更された状態を作るためです。次に、作成した一時ファイルのパスを使ってSplFileObjectのインスタンスを作成します。このオブジェクトを通じてgetCTimeメソッドを呼び出すことで、ファイルの最終 inode 変更時刻を取得します。取得したUNIXタイムスタンプは、date関数を用いて人間が読める「年-月-日 時:分:秒」形式に変換されて表示されます。ファイル操作中のエラー（一時ファイルの作成失敗やファイルへの書き込み失敗、またはgetCTimeメソッドの実行失敗など）が発生した場合の処理も含まれており、プログラムの終了時には作成した一時ファイルを確実に削除してシステムをクリーンアップします。このコードは、getCTimeメソッドがファイルのメタデータ変更時刻をどのように取得し、その情報を利用できるかを具体的に示しています。