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

Copy
1<?php
2
3/**
4 * PharFileInfo::getCTime メソッドの使用例を示します。
5 * Pharアーカイブを作成し、その中のファイルの変更時刻（ctime）をUNIXタイムスタンプで取得します。
6 *
7 * ctime (change time) は、ファイルのiノードの最終変更時刻を示します。
8 * ファイルの内容やメタデータ（所有者、パーミッションなど）が変更された場合に更新されます。
9 */
10function demoPharFileInfoGetCTime(): void
11{
12    // 一時的なPharアーカイブのパスと、アーカイブ内のファイル名を定義
13    $pharPath = __DIR__ . '/my_sample_archive.phar';
14    $filePathInPhar = 'example_file.txt';
15    $fileContent = 'This is some content for the file inside the Phar archive.';
16
17    // 古いアーカイブファイルが残っている場合は削除し、クリーンな状態にする
18    if (file_exists($pharPath)) {
19        unlink($pharPath);
20        echo "既存のPharアーカイブ '{$pharPath}' を削除しました。\n";
21    }
22
23    try {
24        // STEP 1: Pharアーカイブを作成し、テストファイルを内部に追加する
25        // 新しいPharオブジェクトを作成（書き込みモード）。
26        // PHP設定でphar.readonly=0である必要があります。
27        $phar = new Phar($pharPath);
28
29        // Pharファイルを書き込み可能にし、実行スタブを設定（Pharアーカイブが正しく機能するために推奨）
30        $phar->setStub($phar->createDefaultStub($filePathInPhar));
31        $phar->startBuffering(); // バッファリングを開始し、効率的にファイルを追加
32
33        // アーカイブ内にテストファイルを追加
34        $phar->addFromString($filePathInPhar, $fileContent);
35
36        $phar->stopBuffering(); // バッファリングを終了し、変更をPharファイルに書き込む
37
38        echo "Pharアーカイブ '{$pharPath}' を正常に作成し、ファイル '{$filePathInPhar}' を追加しました。\n\n";
39
40        // STEP 2: 作成したPharアーカイブから、特定のファイルのPharFileInfoオブジェクトを取得する
41        // Pharオブジェクトを再度開き（読み込みモード）、アーカイブ内のファイルにアクセスする準備をする
42        $phar = new Phar($pharPath);
43
44        // PharオブジェクトはArrayAccessインターフェースを実装しているため、配列のようにファイルにアクセス可能
45        // これにより、アーカイブ内のファイルに関する情報を持つPharFileInfoオブジェクトが返される
46        $fileInfo = $phar[$filePathInPhar];
47
48        // PharFileInfoオブジェクトが正しく取得できたかを確認
49        if ($fileInfo instanceof PharFileInfo) {
50            echo "Pharアーカイブからファイル '{$filePathInPhar}' の情報オブジェクトを取得しました。\n";
51
52            // STEP 3: getCTime メソッドを使用して、ファイルの変更時刻（ctime）を取得する
53            // getCTime() は、UNIXタイムスタンプ（エポックからの秒数）または失敗時に false を返す
54            $cTime = $fileInfo->getCTime();
55
56            // 取得した値が有効なタイムスタンプであるか確認
57            if ($cTime !== false) {
58                echo "取得した変更時刻 (ctime) UNIXタイムスタンプ: {$cTime}\n";
59                // UNIXタイムスタンプを人間が読める日付と時刻の形式に変換して表示
60                echo "人間が読める形式: " . date('Y-m-d H:i:s', $cTime) . "\n";
61            } else {
62                echo "エラー: ファイル '{$filePathInPhar}' の変更時刻の取得に失敗しました。\n";
63            }
64        } else {
65            echo "エラー: Pharアーカイブからファイル '{$filePathInPhar}' の情報オブジェクトを取得できませんでした。\n";
66        }
67
68    } catch (PharException $e) {
69        // Pharアーカイブ操作中に発生した例外を捕捉し、エラーメッセージを表示
70        echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
71    } finally {
72        // 後処理: 作成した一時的なPharファイルを削除する
73        if (file_exists($pharPath)) {
74            unlink($pharPath);
75            echo "\nクリーンアップ: Pharアーカイブ '{$pharPath}' を削除しました。\n";
76        }
77    }
78}
79
80// サンプル関数を実行して、PharFileInfo::getCTime の動作を確認
81demoPharFileInfoGetCTime();
82
83?>

PharFileInfo::getCTimeは、PHPのPhar（PHPアーカイブ）拡張機能で使用されるメソッドで、Pharアーカイブ内に格納された特定のファイルの変更時刻（ctime）を取得します。Pharは、複数のPHPファイルや関連リソースを一つのアーカイブファイルとしてまとめることができるため、アプリケーションの配布やデプロイに便利です。

ctimeとは、ファイルのiノード（ファイルに関するメタデータ）が最後に変更された時刻を指し、ファイルの内容が更新された場合だけでなく、所有者やパーミッションなどのメタデータが変更された場合にも更新されます。このメソッドは引数を取らず、成功するとUNIXタイムスタンプ（1970年1月1日 00:00:00 UTCからの秒数）を整数値で返します。操作に失敗した場合はfalseが返されます。

提供されたサンプルコードでは、まず一時的なPharアーカイブを作成し、その中にテストファイルを追加しています。次に、作成したPharアーカイブから特定のファイルのPharFileInfoオブジェクトを取得し、そのオブジェクトのgetCTime()メソッドを呼び出して変更時刻を取得しています。取得されたUNIXタイムスタンプは、PHPのdate()関数などを使うことで「YYYY-MM-DD HH:MM:SS」のような人間が読みやすい形式に変換して表示できるため、アーカイブ内のファイルの変更履歴を確認する際に役立ちます。

Copy
1<?php
2
3declare(strict_types=1);
4
5// Define a temporary Phar archive name and an internal file name for demonstration.
6$pharFileName = 'example_archive.phar';
7$internalFileName = 'data/sample.txt';
8$content = 'This is a test file inside the Phar archive.';
9
10try {
11    // --- 1. Pharアーカイブの作成 (デモンストレーション用) ---
12    // Pharアーカイブを作成します。Phar拡張が有効で、php.iniで'phar.readonly = 0'が設定されている必要があります。
13    echo "Creating Phar archive '{$pharFileName}'...\n";
14    $phar = new Phar($pharFileName);
15
16    // アーカイブ操作のバッファリングを開始します。
17    $phar->startBuffering();
18
19    // 指定された内容で新しいファイルをPharアーカイブに追加します。
20    $phar->addFromString($internalFileName, $content);
21
22    // Pharファイルを自己実行可能にするためのスタブを設定します。
23    $phar->setStub($phar->createDefaultStub($internalFileName));
24
25    // バッファリングを停止し、Pharアーカイブをディスクに保存します。
26    $phar->stopBuffering();
27    echo "Phar archive created successfully.\n\n";
28
29    // --- 2. Pharアーカイブを開き、内部ファイル情報を取得 ---
30    // 作成したPharアーカイブを読み取りモードで開きます。
31    $phar = new Phar($pharFileName);
32
33    // 指定された内部ファイルのPharFileInfoオブジェクトを取得します。
34    // このオブジェクトを通じて、アーカイブ内のファイルのメタデータにアクセスできます。
35    if (isset($phar[$internalFileName])) {
36        $pharFileInfo = $phar[$internalFileName];
37
38        echo "Attempting to get creation time for '{$internalFileName}'...\n";
39
40        // --- 3. getCTime() メソッドの使用 ---
41        // getCTime()メソッドを使用して、ファイルの作成時刻 (Unixタイムスタンプ) を取得します。
42        // 戻り値はint (タイムスタンプ) または false (失敗時) です。
43        $creationTime = $pharFileInfo->getCTime();
44
45        if ($creationTime !== false) {
46            // Unixタイムスタンプを人間が読める形式の日付と時刻に変換します。
47            $formattedTime = date('Y-m-d H:i:s', $creationTime);
48            echo "Creation time of '{$internalFileName}': {$formattedTime} (Unix timestamp: {$creationTime})\n";
49        } else {
50            echo "Failed to retrieve creation time for '{$internalFileName}'.\n";
51        }
52    } else {
53        echo "Error: File '{$internalFileName}' not found within '{$pharFileName}'.\n";
54    }
55
56} catch (PharException $e) {
57    // Phar関連のエラーを捕捉します。
58    echo "PharException: " . $e->getMessage() . "\n";
59    echo "Please ensure 'phar.readonly' is set to '0' in your php.ini for writing operations.\n";
60} catch (Exception $e) {
61    // その他の予期せぬエラーを捕捉します。
62    echo "An unexpected error occurred: " . $e->getMessage() . "\n";
63} finally {
64    // --- 4. クリーンアップ: 一時的なPharファイルの削除 ---
65    // スクリプトの実行後、作成した一時ファイルを削除します。
66    if (file_exists($pharFileName)) {
67        unlink($pharFileName);
68        echo "\nCleaned up: Removed '{$pharFileName}'.\n";
69    }
70}
71

このPHPサンプルコードは、Pharアーカイブ内に格納されたファイルの作成時刻をPharFileInfo::getCTime()メソッドで取得する方法を示しています。

まず、デモンストレーション用にexample_archive.pharという名前のPharアーカイブを作成し、その中にdata/sample.txtというテストファイルを格納します。Pharアーカイブは、複数のファイルを一つの実行可能なアーカイブにまとめることができるPHPの機能です。

次に、作成したPharアーカイブを読み込み、内部のdata/sample.txtに対応するPharFileInfoオブジェクトを取得します。PharFileInfoは、Pharアーカイブ内の特定のファイルに関するメタデータにアクセスするためのオブジェクトです。

取得した$pharFileInfoオブジェクトに対してgetCTime()メソッドを呼び出すと、対象ファイルの作成時刻がUnixタイムスタンプ形式（整数値）で返されます。このメソッドは引数を必要としません。もし時刻の取得に失敗した場合はfalseが戻り値として返されます。サンプルコードでは、取得したタイムスタンプをdate()関数で人間が読める形式に変換し、具体的な日時として表示しています。

最終的に、このデモンストレーションで作成した一時的なPharアーカイブファイルは、finallyブロックで確実に削除され、クリーンアップが行われます。このgetCTime()メソッドは、Pharアーカイブ内のファイルの作成日時をプログラムで確認したい場合に有用です。