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

Copy
1<?php
2
3/**
4 * Pharアーカイブのエントリが有効かどうかを検証するサンプルコード。
5 *
6 * Phar::valid() メソッドは、Pharオブジェクトがイテレータとして使用される際に、
7 * 現在のイテレータ位置が有効なエントリを指している場合に true を返します。
8 * 無効なエントリ（例：ファイルの終わりに達した場合）を指している場合は false を返します。
9 */
10
11// スクリプトの実行中にPharアーカイブの作成・変更を許可するため、
12// 一時的に 'phar.readonly' 設定をオフにします。
13// 本番環境では、セキュリティ上の理由から 'On' に設定されていることがほとんどです。
14ini_set('phar.readonly', 0);
15
16$pharFileName = 'my_example.phar'; // 作成するPharアーカイブのファイル名
17
18// 以前の実行で残ったPharファイルがあれば削除してクリーンな状態にします。
19if (file_exists($pharFileName)) {
20    unlink($pharFileName);
21}
22
23try {
24    // 1. 新しいPharアーカイブを作成します。
25    // 第1引数: Pharアーカイブのパスとファイル名。
26    // 第2引数: ファイルフラグ (0は通常のPharファイル)。
27    // 第3引数: このPharアーカイブを参照するためのエイリアス（オプションですが推奨）。
28    $phar = new Phar($pharFileName, 0, 'my_example.phar');
29
30    // アーカイブにファイルをいくつか追加します。
31    // addFromStringメソッドは、ファイルの内容を文字列として直接追加できます。
32    $phar->addFromString('index.php', '<?php echo "Hello from Phar!";');
33    $phar->addFromString('config.php', '<?php define("VERSION", "1.0");');
34    $phar->addFromString('data/message.txt', 'This is a test message.');
35
36    // Pharアーカイブへの書き込みを終了し、ファイルシステムにコミットします。
37    // これにより、Pharファイルが完成し、読み取り可能になります。
38    $phar->stopBuffering();
39
40    echo "Pharアーカイブ '{$pharFileName}' が正常に作成されました。\n";
41
42    // 2. 作成したPharアーカイブをイテレータとして扱い、エントリの有効性を検証します。
43    echo "\n--- Pharアーカイブ内のエントリ検証を開始します ---\n";
44
45    // イテレータのポインタを最初の要素にリセットします。
46    $phar->rewind();
47
48    $validEntryCount = 0;
49    // Phar::valid() メソッドを使って、現在のイテレータ位置が有効なエントリを指している間、ループを続けます。
50    while ($phar->valid()) {
51        $entryName = $phar->key(); // 現在のエントリの名前（ファイルパス）を取得します。
52
53        echo "  [有効なエントリを見つけました]: '{$entryName}'\n";
54
55        // 必要であれば、現在のエントリの内容なども取得できます (例: $phar->current()->getContent())。
56        
57        $phar->next(); // イテレータのポインタを次のエントリに進めます。
58        $validEntryCount++;
59    }
60
61    echo "--- エントリ検証が完了しました ---\n";
62    echo "Pharアーカイブ内で {$validEntryCount} 個の有効なエントリが見つかりました。\n";
63
64} catch (Exception $e) {
65    // Phar操作中に発生した例外をキャッチし、エラーメッセージを表示します。
66    echo "エラーが発生しました: " . $e->getMessage() . "\n";
67} finally {
68    // スクリプトの実行が終了する際に、作成したPharファイルを削除し、クリーンアップします。
69    if (file_exists($pharFileName)) {
70        unlink($pharFileName);
71        echo "\nPharアーカイブ '{$pharFileName}' を削除しました。\n";
72    }
73    // 'phar.readonly' の設定は、スクリプト終了時にPHPによって自動的に元の値に戻されます。
74}

PHPのPhar::valid()メソッドは、Pharアーカイブ内の現在のイテレータ位置が有効なエントリを指しているかどうかを検証するために使用されます。このメソッドは引数を一切取らず、戻り値として真偽値（bool）を返します。

Pharオブジェクトをイテレータとして利用し、アーカイブ内のファイルやディレクトリを順次処理する際に、現在の位置が有効なエントリ（ファイルなど）を指している場合はtrueを返します。これにより、アーカイブの最後まで確実に処理を継続できます。一方、無効なエントリを指している場合や、アーカイブの終わりに達してこれ以上エントリが存在しない場合にはfalseを返します。

サンプルコードでは、まずPharアーカイブを作成し、いくつかのファイルをその中に追加しています。その後、$phar->rewind()でイテレータを先頭に戻し、Phar::valid()をwhileループの条件として使用することで、アーカイブ内の有効なエントリを一つずつ安全に処理しています。これにより、各エントリの名前を取得しながら、アーカイブの内容を効率的に走査する様子が示されています。

Copy
1<?php
2
3/**
4 * Pharアーカイブの有効性を検証するサンプルコード。
5 *
6 * この関数は、一時的なPharアーカイブを作成し、そのアーカイブが
7 * 有効であるかどうかをPhar::valid()メソッドを使って検証します。
8 * システムエンジニアを目指す初心者が、Pharアーカイブの基本的な
9 * 扱い方と、その健全性をチェックする方法を理解するのに役立ちます。
10 */
11function validatePharArchiveValidity(): void
12{
13    // 一時的なPharファイルの名前とパスを定義します。
14    // スクリプトが実行されているディレクトリに作成されます。
15    $pharFileName = 'my_temp_app.phar';
16    $pharFilePath = __DIR__ . DIRECTORY_SEPARATOR . $pharFileName;
17
18    echo "Pharアーカイブの有効性検証を開始します。\n";
19
20    // 以前の実行で残ったPharファイルが存在する場合は削除します。
21    if (file_exists($pharFilePath)) {
22        echo "既存の '{$pharFileName}' を削除しています...\n";
23        unlink($pharFilePath);
24    }
25
26    try {
27        // 1. 新しいPharアーカイブを作成します。
28        // ここでは、指定されたパスに新しいPharファイルとして開かれ、書き込みが可能になります。
29        echo "新しいPharアーカイブ '{$pharFileName}' を作成中...\n";
30        $phar = new Phar($pharFilePath);
31
32        // Pharのデフォルトのスタブ（起動スクリプト）を設定します。
33        // これがないとPharとして機能しません。通常、pharファイルの先頭部分です。
34        $phar->setStub($phar->createDefaultStub('index.php'));
35
36        // アーカイブにファイルを追加します。
37        $phar->addFromString('index.php', '<?php echo "Hello from Phar!";');
38        $phar->addFromString('config.php', '<?php define("APP_VERSION", "1.0");');
39
40        // アーカイブ内のファイルをGZIPで圧縮します。
41        $phar->compressFiles(Phar::GZ);
42
43        // バッファリングを停止し、変更をPharファイルに書き込みます。
44        // この時点でPharファイルが完成し、ディスクに保存されます。
45        $phar->stopBuffering();
46
47        echo "Pharアーカイブ '{$pharFileName}' が正常に作成されました。\n";
48
49        // 2. 作成したPharアーカイブを読み込みモードで開きます。
50        // 新しいPharオブジェクトを作成することで、書き込み中の状態ではなく、
51        // 完成したPharファイルとして検証できるようになります。
52        echo "作成されたPharアーカイブを読み込みモードで開いています...\n";
53        // Pharコンストラクタは、既存のPharファイルを指定すると読み込みモードで開きます。
54        $pharReader = new Phar($pharFilePath);
55
56        // 3. Phar::valid() メソッドを使ってアーカイブの有効性をチェックします。
57        // このメソッドは、アーカイブが破損していないか、署名が無効でないかなどを確認します。
58        // 戻り値はbool型で、有効であればtrue、無効であればfalseです。
59        $isValid = $pharReader->valid();
60
61        if ($isValid) {
62            echo "結果: '{$pharFileName}' は有効なPharアーカイブです。\n";
63        } else {
64            // 通常、Phar::valid() はアーカイブが破損している、または署名が無効な場合に false を返します。
65            echo "結果: '{$pharFileName}' は無効なPharアーカイブです。\n";
66        }
67
68    } catch (PharException $e) {
69        // Pharクラスの操作中にエラーが発生した場合、ここで捕捉します。
70        // 例: PHPの設定 'phar.readonly' が '1' の場合に書き込みを行おうとした場合など。
71        echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
72    } finally {
73        // 4. クリーンアップ: 作成した一時的なPharファイルを削除します。
74        if (file_exists($pharFilePath)) {
75            echo "一時ファイル '{$pharFileName}' をクリーンアップ中...\n";
76            unlink($pharFilePath); // PHPの一般的なファイル削除関数を使用します。
77            echo "クリーンアップが完了しました。\n";
78        }
79    }
80}
81
82// 関数の実行
83validatePharArchiveValidity();
84

Phar::valid()メソッドは、PHPのPhar拡張機能に属し、指定されたPharアーカイブが有効であるかを検証するために利用されます。このメソッドは引数を取らず、アーカイブが適切に構築され、破損がなく、署名などの整合性が取れている場合にtrueを、そうでない場合にfalseをbool型で返します。

提供されたサンプルコードでは、まず一時的なPharアーカイブ（my_temp_app.phar）を新規作成しています。このアーカイブにはスタブと、いくつかのダミーファイルが追加され、GZIPで圧縮されてディスクに保存されます。Pharアーカイブが完成した後、それを読み込みモードで再度開き、そのPharオブジェクトに対してvalid()メソッドを呼び出します。これにより、作成されたPharファイルが実際に有効な形式であるかがプログラムによって確認されます。結果はコンソールに表示され、有効であれば「有効なPharアーカイブです」と、そうでなければ「無効なPharアーカイブです」と示されます。最後に、作成した一時ファイルは、クリーンアップとして確実に削除されます。このプロセスは、Pharアーカイブの作成、読み込み、そしてその健全性をプログラム的に確認する基本的な流れを学ぶ上で役立ちます。