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

Copy
1<?php
2
3/**
4 * Phar::getModified() メソッドの動作を示すサンプルコードです。
5 * このメソッドは、Pharアーカイブが最後にロードまたは作成されてから
6 * 内部的に変更されたかどうかを真偽値で返します。
7 *
8 * 注: 'php getmypid' キーワードはPhar::getModified()メソッドと直接的な関連性がないため、
9 * このサンプルコードには含まれていません。このコードはPharアーカイブの変更状態の確認に焦点を当てています。
10 */
11
12// 一時的なPharファイルの名前を定義します。
13$pharFileName = 'example_archive.phar';
14// Pharファイルの完全なパスを構築します。これはスクリプトと同じディレクトリに作成されます。
15$pharFilePath = __DIR__ . DIRECTORY_SEPARATOR . $pharFileName;
16
17// 以前に作成されたPharファイルが存在する場合は削除し、クリーンな状態から始めます。
18if (file_exists($pharFilePath)) {
19    unlink($pharFilePath);
20}
21
22try {
23    echo "--- Pharアーカイブの作成と変更状態の確認 ---\n";
24
25    // 1. 新しいPharアーカイブを作成します（書き込みモード）。
26    // 第一引数: Pharアーカイブのパス
27    // 第二引数: 0 は何もフラグを設定しない（デフォルト）
28    // 第三引数: アーカイブの内部的なエイリアス名
29    $phar = new Phar($pharFilePath, 0, $pharFileName);
30
31    // Pharアーカイブを実行可能にするためのスタブを設定します。これはPharアーカイブに必須の要素です。
32    // ここで設定した時点では、アーカイブの「ユーザーデータ」部分はまだ変更されていません。
33    $phar->setStub('<?php __HALT_COMPILER(); ?>');
34
35    // Pharオブジェクトを作成し、スタブを設定した直後の変更状態を確認します。
36    // この時点では、ユーザーが追加したファイルはないため、通常は「変更なし」(false)と報告されるはずです。
37    echo "Phar作成直後（スタブ設定後）: " . ($phar->getModified() ? "変更あり" : "変更なし") . "\n";
38
39    // 2. Pharアーカイブに新しいファイルを追加し、内容を変更します。
40    // addFromString() はPharの内容を直接変更する操作です。
41    $phar->addFromString('file1.txt', 'これはテストファイル1の内容です。');
42
43    // ファイル追加後の変更状態を確認します。
44    // アーカイブの内容が変更されたため、「変更あり」(true)と報告されるはずです。
45    echo "ファイル追加後 (file1.txt): " . ($phar->getModified() ? "変更あり" : "変更なし") . "\n";
46
47    // さらに別のファイルを追加して、変更状態を確認します。
48    $phar->addFromString('file2.txt', 'これはテストファイル2の内容です。');
49    echo "ファイル追加後 (file2.txt): " . ($phar->getModified() ? "変更あり" : "変更なし") . "\n";
50
51    // Pharオブジェクトを解放し、アーカイブファイルへの変更を確定させます。
52    // この操作によってPharファイルがディスクに書き込まれます。
53    $phar = null;
54
55    echo "\n--- 既存のPharアーカイブを読み込みモードで開いて確認 ---\n";
56
57    // 3. 作成されたPharアーカイブを読み込みモードで再度開きます。
58    // 新しくロードされたPharオブジェクトは、デフォルトで「変更なし」と見なされます。
59    // getModified() は、そのPharオブジェクトがロードされてからの変更を追跡するためです。
60    $pharReadOnly = new Phar($pharFilePath);
61
62    // 読み込みモードで開いた直後の変更状態を確認します。
63    // 再度ロードされたため、「変更なし」(false)と報告されるはずです。
64    echo "読み込みモードで開いた直後: " . ($pharReadOnly->getModified() ? "変更あり" : "変更なし") . "\n";
65
66    // 読み込みモードのPharオブジェクトは内容を変更できません。
67    // 例えば $pharReadOnly->addFromString(...) のような操作は例外をスローします。
68    // そのため、ここでは変更を試みるコードは含めていません。
69
70} catch (PharException $e) {
71    // Phar操作中に発生した例外をキャッチし、エラーメッセージを表示します。
72    echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
73} finally {
74    // 最後に、作成した一時的なPharファイルをクリーンアップします。
75    if (file_exists($pharFilePath)) {
76        unlink($pharFilePath);
77        echo "\n一時的なPharアーカイブ '{$pharFileName}' を削除しました。\n";
78    }
79}
80
81?>

PHPのPhar::getModified()メソッドは、現在操作しているPharアーカイブが、最後にロードまたは作成されてから内容が変更されたかどうかを真偽値で判定する際に使用されます。このメソッドは引数を取らず、変更があった場合はtrueを、変更がない場合はfalseを返します。

サンプルコードでは、まず新しいPharアーカイブを作成し、スタブを設定した直後では、まだユーザーデータに当たるファイルを追加していないため、getModified()はfalseを返します。その後、addFromString()メソッドでアーカイブ内にファイルを追記すると、内部的に変更が発生したためgetModified()はtrueを返します。このように、アーカイブに対する書き込み操作が行われるたびに変更状態が検出されます。

一度作成・変更されたPharアーカイブを保存し、その後読み込みモードで再度開いた場合、新しく作成されたPharオブジェクトとしてはまだ何も変更を加えていないため、getModified()は再びfalseを返します。これは、getModified()がPharオブジェクトが「ロードされてからの変更」を追跡するためです。このメソッドを利用することで、プログラムがPharアーカイブに変更を加えたかどうかを簡単に確認できます。

Copy
1<?php
2
3/**
4 * Phar::getModified() メソッドの使用例
5 *
6 * このメソッドは、Pharアーカイブオブジェクトがインスタンス化されてから、
7 * そのアーカイブの内容が変更されたかどうか（追加、削除など）を示すブール値を返します。
8 * 変更がディスクに書き込まれる (Phar::stopBuffering()) と、このフラグはリセットされます。
9 */
10
11$pharFileName = __DIR__ . '/example.phar'; // 生成する一時的なPharファイル名
12
13// スクリプトの実行終了時に、生成されたPharファイルを削除するクリーンアップ関数を登録します。
14register_shutdown_function(function () use ($pharFileName) {
15    if (file_exists($pharFileName)) {
16        unlink($pharFileName);
17    }
18    // 圧縮オプションを使用した場合に生成される可能性のあるファイルも考慮します。
19    if (file_exists($pharFileName . '.gz')) {
20        unlink($pharFileName . '.gz');
21    }
22});
23
24try {
25    // 1. Pharオブジェクトを新規作成または既存のファイルを読み込みます。
26    //    デフォルトで書き込みバッファリングが有効になります。
27    $phar = new Phar($pharFileName);
28    echo "Pharアーカイブの準備: {$pharFileName}\n";
29
30    // 初期状態の modified フラグを確認します。
31    // アーカイブにはまだ何も変更を加えていないため、falseを返すはずです。
32    echo "1. 初期状態の modified フラグ: " . ($phar->getModified() ? 'true' : 'false') . "\n";
33
34    // 2. アーカイブにファイルを追加して変更を加えます。
35    $fileContent = '<?php echo "Hello from inside the Phar archive!";';
36    $phar->addFromString('hello.php', $fileContent);
37    echo "2. 'hello.php' をアーカイブに追加しました。\n";
38
39    // ファイル追加後の modified フラグを確認します。
40    // アーカイブの内容が変更されたため、trueを返すはずです。
41    echo "3. ファイル追加後の modified フラグ: " . ($phar->getModified() ? 'true' : 'false') . "\n";
42
43    // 4. Pharアーカイブへの変更をディスクに書き込み、バッファリングを停止します。
44    //    この操作により、Pharオブジェクトの内部的な modified フラグはリセットされます。
45    //    例として gzip 圧縮を適用します。
46    $phar->compressFiles(Phar::GZ); // オプションの圧縮処理
47    $phar->stopBuffering();
48    echo "4. Pharアーカイブへの変更を保存し、バッファリングを停止しました。\n";
49
50    // 5. バッファリング停止後の modified フラグを確認します。
51    //    変更がディスクに書き込まれ、フラグがリセットされたため、falseを返すはずです。
52    echo "5. バッファリング停止後の modified フラグ: " . ($phar->getModified() ? 'true' : 'false') . "\n";
53
54} catch (Exception $e) {
55    // Phar操作中にエラーが発生した場合、メッセージを出力します。
56    echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
57}
58
59?>

Phar::getModified()メソッドは、PHPでPharアーカイブ（複数のファイルを一つにまとめた実行可能なアーカイブファイル）を操作する際に、そのアーカイブの内容がインスタンス化されてから変更されたかどうかを確認するために使用されます。このメソッドは引数を取らず、変更があった場合はtrue、変更がない場合はfalseという真偽値を返します。

具体的には、Pharオブジェクトを新規作成または読み込んだ直後は、まだ内容に変更がないためgetModified()はfalseを返します。しかし、addFromString()などでアーカイブにファイルを追加したり、既存のファイルを変更・削除したりすると、アーカイブの内容が変更されたと判断され、getModified()はtrueを返すようになります。

特に重要な点として、Phar::stopBuffering()メソッドが呼び出され、バッファリングされていた変更が実際にディスク上のPharファイルに書き込まれると、この「変更された」という内部フラグはリセットされます。そのため、変更が永続化された後では、getModified()は再びfalseを返します。このメソッドは、Pharアーカイブの状態をプログラムで確認し、適切な処理を行う際に役立ちます。