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

Copy
1<?php
2
3/**
4 * Phar::isReadable() メソッドの使用例を示します。
5 * Phar アーカイブを作成し、そのアーカイブが読み込み可能であることを確認します。
6 *
7 * @param string $archiveName 作成および確認するPharアーカイブのファイル名
8 */
9function demonstratePharIsReadable(string $archiveName): void
10{
11    // 一時的なPharファイルのフルパスを生成
12    $pharFilePath = __DIR__ . DIRECTORY_SEPARATOR . $archiveName;
13
14    // --- Pharアーカイブの作成 ---
15    try {
16        // 既存のファイルを削除し、テストの再現性を確保
17        if (file_exists($pharFilePath)) {
18            Phar::unlinkArchive($pharFilePath);
19            echo "既存のPharアーカイブ '{$pharFilePath}' を削除しました。\n";
20        }
21
22        // 新しいPharアーカイブを書き込みモードで作成
23        // 第二引数: 0 (Phar::CREATE のエイリアス。PHP 7.2 以降は推奨されないが互換性のため許容)
24        // 第三引数: アーカイブの内部名（通常はファイル名と同じで良い）
25        $phar = new Phar($pharFilePath, 0, $archiveName);
26
27        // バッファリングを開始し、アーカイブへの書き込みを準備
28        $phar->startBuffering();
29
30        // アーカイブにダミーファイルを追加
31        $phar->addFromString('example.txt', 'This is a test content for the Phar archive.');
32
33        // バッファリングを終了し、アーカイブを保存
34        $phar->stopBuffering();
35
36        echo "Pharアーカイブ '{$pharFilePath}' が正常に作成されました。\n";
37
38    } catch (PharException $e) {
39        echo "Pharアーカイブの作成中にエラーが発生しました: " . $e->getMessage() . "\n";
40        return; // エラー発生時はこれ以上処理を進めない
41    }
42
43    // --- Pharアーカイブの読み込みとisReadable() メソッドの確認 ---
44    try {
45        // 作成したPharファイルを読み込みモードでオープン
46        // Pharオブジェクトが正常に作成されれば、通常は読み込み可能であるはず
47        $phar = new Phar($pharFilePath);
48
49        // Phar::isReadable() を呼び出して、アーカイブが読み込み可能かチェック
50        if ($phar->isReadable()) {
51            echo "Pharアーカイブは現在、読み込み可能です。\n";
52
53            // （オプション）アーカイブ内のファイルリストを表示し、読み込み可能であることを実証
54            echo "アーカイブ内のファイル:\n";
55            foreach ($phar as $file) {
56                echo "- " . $file->getFilename() . "\n";
57            }
58        } else {
59            echo "Pharアーカイブは読み込み不可能です。\n";
60        }
61
62    } catch (PharException $e) {
63        echo "Pharアーカイブの読み込み中にエラーが発生しました: " . $e->getMessage() . "\n";
64    } finally {
65        // --- 後処理：作成したPharファイルを削除 ---
66        // Phar::unlinkArchive() を使用して安全にPharアーカイブを削除
67        if (file_exists($pharFilePath)) {
68            Phar::unlinkArchive($pharFilePath);
69            echo "Pharアーカイブ '{$pharFilePath}' を削除しました。\n";
70        }
71    }
72}
73
74// サンプルコードを実行
75demonstratePharIsReadable('my_sample.phar');
76

PHP 8のPharクラスは、PHPアプリケーションを構成する複数のファイルやリソースを一つにまとめて配布・実行するためのアーカイブ（.pharファイル）を作成・操作する機能を提供します。このPhar::isReadable()メソッドは、指定されたPharアーカイブが、現在の環境でPHPによって正常に読み込み可能であるかを確認するために使用されます。

このメソッドは引数を必要としません。呼び出されると、対象のPharアーカイブファイルが存在し、PHPがその内容を読み取ることができる状態であればtrue（真）を、そうでなければfalse（偽）というブール値を戻り値として返します。例えば、ファイルのパスが誤っている場合や、ファイルに対する読み取り権限がない場合などにfalseが返される可能性があります。

サンプルコードでは、まずmy_sample.pharという新しいPharアーカイブを作成し、その中にダミーのファイルを追加しています。アーカイブが正常に作成された後、改めてそのPharアーカイブを開き、$phar->isReadable()メソッドを呼び出して、読み込み可能であるかを検証します。この検証により、作成したアーカイブファイルが破損していないか、あるいはシステム上のアクセス権の問題がないかなどを確認できます。正常なPharファイルであれば、このメソッドはtrueを返し、その後のアーカイブ内容の処理へと進むことが示されています。最後に、テスト用に作成されたPharアーカイブはクリーンアップのために削除されます。

Copy
1<?php
2
3// 一時的なPharファイル名を定義します。
4// システムの一時ディレクトリを使用し、クリーンアップしやすいようにします。
5$pharFileName = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'my_temp_app.phar';
6$alias = 'my_temp_app.phar'; // Pharアーカイブのエイリアス
7
8/**
9 * Phar::isReadable メソッドの動作を示す関数。
10 * このメソッドは、Pharアーカイブが読み取り可能かどうかをチェックします。
11 * 通常、Pharオブジェクトが正常に作成されれば true を返しますが、
12 * 特定の状況下では false を返すことがあります。
13 *
14 * キーワード「php is_readable false」に沿って、falseを返すケースを再現します。
15 * PHPの `phar.readonly` 設定を利用して、アーカイブを読み取り専用として扱い、
16 * `Phar::isReadable` が false を返すシナリオをシミュレートします。
17 *
18 * @return void
19 */
20function demonstratePharIsReadable(): void
21{
22    global $pharFileName, $alias;
23
24    echo "--- Phar::isReadable のデモンストレーション ---\n\n";
25
26    // 1. Pharアーカイブを作成し、isReadableがtrueを返すことを確認するシナリオ
27    // phar.readonly を一時的に '0' (書き込み可能) に設定し、Pharアーカイブの作成を許可します。
28    // スクリプト終了時に元の設定に戻すために、現在の設定を保存しておきます。
29    $originalPharReadonly = ini_get('phar.readonly');
30    ini_set('phar.readonly', '0');
31
32    // 既存のPharファイルをクリーンアップ
33    if (file_exists($pharFileName)) {
34        unlink($pharFileName);
35    }
36
37    echo "=== シナリオ 1: 通常のPharアーカイブ (書き込み可能) ===\n";
38    try {
39        // 新しいPharアーカイブを作成します (存在しない場合は作成されます)。
40        // 第二引数の0はFilesystemIteratorフラグのデフォルト値です。
41        $phar = new Phar($pharFileName, 0, $alias);
42
43        // バッファリングを開始し、ファイルを追加します。
44        $phar->startBuffering();
45        $phar->addFromString('index.php', '<?php echo "Hello from Phar!";');
46        $phar->setStub('<?php __HALT_COMPILER();'); // 実行スタブを設定
47        $phar->stopBuffering(); // バッファリングを終了し、アーカイブを保存します。
48
49        echo "Pharアーカイブ '{$pharFileName}' を作成しました。\n";
50
51        // isReadableの結果を確認します。
52        // 作成されたばかりのPharアーカイブは通常、読み取り可能です。
53        if ($phar->isReadable()) {
54            echo "-> Pharアーカイブは読み取り可能です (isReadable: true)。\n";
55        } else {
56            echo "-> Pharアーカイブは読み取り不可能です (isReadable: false)。\n";
57        }
58
59        // Pharオブジェクトを解放します。
60        // これにより、ファイルハンドルが閉じられ、次のini_setが安全に適用できます。
61        unset($phar);
62
63    } catch (PharException $e) {
64        echo "Pharアーカイブの作成中にエラーが発生しました: " . $e->getMessage() . "\n";
65        // エラーが発生した場合は、後続のシナリオに進む前に終了します。
66        ini_set('phar.readonly', $originalPharReadonly); // 設定を元に戻す
67        if (file_exists($pharFileName)) {
68            unlink($pharFileName);
69        }
70        return;
71    }
72    echo "\n";
73
74    // 2. 読み取り専用設定下でPharアーカイブをロードし、isReadableがfalseを返すことを確認するシナリオ
75    echo "=== シナリオ 2: 読み取り専用設定下でのPharアーカイブ (isReadable: false を期待) ===\n";
76    // phar.readonly を '1' (読み取り専用) に設定します。
77    // この設定は、既存のPharアーカイブを読み込む際には影響しませんが、
78    // Phar::isReadable() の内部的な振る舞いによっては false を返す可能性があります。
79    // (公式ドキュメントには "Checks whether the phar archive can be written to or not." との記述があるため)
80    ini_set('phar.readonly', '1');
81
82    try {
83        // 既存のPharアーカイブを再度オープンします。
84        // phar.readonly=1 の設定下では、Pharは書き込み不可として扱われます。
85        // もしisReadableがisWritableと同じ意味で動作する場合、falseが期待されます。
86        $phar = new Phar($pharFileName, 0, $alias);
87
88        echo "既存のPharアーカイブ '{$pharFileName}' を読み取り専用設定でオープンしました。\n";
89
90        // isReadableの結果を確認します。
91        // phar.readonly=1 の設定下で、Pharアーカイブが書き込み不可能であると判断される場合、
92        // このメソッドは false を返すことが期待されます。
93        if ($phar->isReadable()) {
94            echo "-> Pharアーカイブは読み取り可能です (isReadable: true)。\n";
95        } else {
96            echo "-> Pharアーカイブは読み取り不可能です (isReadable: false)。\n";
97            echo "   これは、`phar.readonly = 1` の設定が有効であるか、\n";
98            echo "   またはアーカイブへの書き込みが許可されていない状況を示唆しています。\n";
99            echo "   (Phar::isReadable のドキュメントの記述が「書き込み可能か」をチェックする場合)\n";
100        }
101
102        // Pharオブジェクトを解放します。
103        unset($phar);
104
105    } catch (PharException $e) {
106        // 読み取り専用設定下では、新しいPharの作成はエラーになりますが、
107        // 既存のPharの読み込みは可能です。
108        echo "Pharアーカイブのオープン中にエラーが発生しました: " . $e->getMessage() . "\n";
109    }
110    echo "\n";
111
112    // 後処理: 元のphar.readonly設定に戻し、一時ファイルを削除します。
113    ini_set('phar.readonly', $originalPharReadonly);
114    if (file_exists($pharFileName)) {
115        unlink($pharFileName);
116        echo "一時的なPharアーカイブ '{$pharFileName}' を削除しました。\n";
117    }
118}
119
120// 関数の実行
121demonstratePharIsReadable();
122
123?>

PHPのPhar::isReadableメソッドは、Pharアーカイブファイルが「読み取り可能であるか」を判定するメソッドです。このメソッドは引数を必要としません。戻り値は真偽値（bool）で、アーカイブが読み取り可能であればtrueを、そうでなければfalseを返します。

通常、適切に作成されたPharオブジェクトに対してはこのメソッドはtrueを返します。しかし、PHPの設定であるphar.readonlyが1（読み取り専用）に設定されている場合など、アーカイブへの書き込みが許可されていない状況ではfalseが返されることがあります。これは、isReadableメソッドが単なる読み込みだけでなく、アーカイブが書き込み可能であるかも内部的にチェックしているためです。

サンプルコードでは、このphar.readonly設定を切り替えることで、isReadableがfalseを返すシナリオを再現しています。具体的には、phar.readonlyを0（書き込み可能）にして作成したPharではtrueが返りますが、その後phar.readonlyを1（読み取り専用）に設定した状態で同じPharを操作すると、isReadableがfalseを返す様子が確認できます。これにより、Pharアーカイブの読み書き権限の状態を簡単に確認できます。