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

Copy
1<?php
2
3/**
4 * Phar::isExecutable() メソッドの動作を示すサンプルです。
5 *
6 * この関数は、PHPアーカイブ (Phar) ファイルが実行可能として作成されているかをチェックする方法を示します。
7 * 実行可能なPharファイルと実行可能でないPharファイルの両方を作成し、
8 * それぞれのisExecutable()メソッドの戻り値を確認します。
9 */
10function demonstratePharIsExecutable(): void
11{
12    // Pharファイルの作成・変更を一時的に許可します。
13    // スクリプト終了後、この設定は元に戻ります。
14    $oldPharReadonly = ini_get('phar.readonly');
15    ini_set('phar.readonly', 0);
16
17    // 一時的に使用するPharファイルのパスを定義します。
18    $executablePharPath = __DIR__ . '/example_executable.phar';
19    $nonExecutablePharPath = __DIR__ . '/example_non_executable.phar';
20    $innerFilePath = 'app.php'; // Phar内部に含めるファイル名
21
22    echo "--- 実行可能なPharファイルのテスト ---" . PHP_EOL;
23    try {
24        // 新しいPharアーカイブを作成します。
25        $phar = new Phar($executablePharPath, 0, 'example_executable.phar');
26        // アーカイブ内にダミーファイルを追加します。
27        $phar->addFromString($innerFilePath, '<?php echo "Hello from executable Phar!";');
28        // Shebang (#!) を含むスタブを設定し、Pharを実行可能にします。
29        $phar->setStub(
30            '#!/usr/bin/env php' . PHP_EOL .
31            '<?php Phar::mapPhar("example_executable.phar"); include "phar://example_executable.phar/' . $innerFilePath . '"; __HALT_COMPILER(); ?>'
32        );
33        unset($phar); // Pharオブジェクトを閉じてファイルへのロックを解除します。
34
35        // 作成したPharを再度読み込み、isExecutable() メソッドを呼び出します。
36        $phar = new Phar($executablePharPath);
37        if ($phar->isExecutable()) {
38            echo "結果: ファイル '{$executablePharPath}' は実行可能です。" . PHP_EOL;
39        } else {
40            echo "結果: ファイル '{$executablePharPath}' は実行可能ではありません。" . PHP_EOL;
41        }
42        unset($phar); // Pharオブジェクトを閉じてファイルへのロックを解除します。
43
44    } catch (Exception $e) {
45        echo "エラーが発生しました (実行可能なPharのテスト): " . $e->getMessage() . PHP_EOL;
46    } finally {
47        // 作成したPharファイルを削除し、クリーンアップします。
48        if (file_exists($executablePharPath)) {
49            unlink($executablePharPath);
50        }
51    }
52
53    echo PHP_EOL; // 出力を見やすくするための改行
54
55    echo "--- 実行可能でないPharファイルのテスト ---" . PHP_EOL;
56    try {
57        // 新しいPharアーカイブを作成します。
58        $phar = new Phar($nonExecutablePharPath, 0, 'example_non_executable.phar');
59        // アーカイブ内にダミーファイルを追加します。
60        $phar->addFromString($innerFilePath, '<?php echo "Hello from non-executable Phar!";');
61        // Shebangを含まないシンプルなスタブを設定し、Pharを実行可能でない状態にします。
62        $phar->setStub(
63            '<?php Phar::mapPhar("example_non_executable.phar"); include "phar://example_non_executable.phar/' . $innerFilePath . '"; __HALT_COMPILER(); ?>'
64        );
65        unset($phar); // ファイルへのロックを解除
66
67        // 作成したPharを再度読み込み、isExecutable() メソッドを呼び出します。
68        $phar = new Phar($nonExecutablePharPath);
69        if ($phar->isExecutable()) {
70            echo "結果: ファイル '{$nonExecutablePharPath}' は実行可能です。" . PHP_EOL;
71        } else {
72            echo "結果: ファイル '{$nonExecutablePharPath}' は実行可能ではありません。" . PHP_EOL;
73        }
74        unset($phar); // ファイルへのロックを解除
75
76    } catch (Exception $e) {
77        echo "エラーが発生しました (実行可能でないPharのテスト): " . $e->getMessage() . PHP_EOL;
78    } finally {
79        // 作成したPharファイルを削除し、クリーンアップします。
80        if (file_exists($nonExecutablePharPath)) {
81            unlink($nonExecutablePharPath);
82        }
83    }
84
85    // phar.readonly の設定を元の値に戻します。
86    ini_set('phar.readonly', $oldPharReadonly);
87}
88
89// 上記のサンプル関数を実行します。
90demonstratePharIsExecutable();

PHPのPhar::isExecutable()メソッドは、PHPアプリケーションを単一のアーカイブファイルとして配布するためのPharファイルが、コマンドラインなどから直接実行できる形式で作成されているかを確認するために使用されます。このメソッドは引数を必要とせず、Pharファイルが直接実行できる場合（通常、ファイルの先頭にPHPインタープリタを指定する#!/usr/bin/env phpのようなshebang行が記述されている場合）にtrueを、そうでない場合にfalseを真偽値として返します。

サンプルコードでは、まずphar.readonlyというPHP設定を一時的に変更し、Pharファイルの作成と変更を許可しています。次に、shebangを含む起動スクリプト（スタブ）を設定した「実行可能なPharファイル」と、shebangを含まないシンプルな起動スクリプトを設定した「実行可能でないPharファイル」の二種類を作成します。それぞれのPharファイルを読み込み直し、isExecutable()メソッドを実行して、期待通りの結果（実行可能なPharにはtrue、そうでないPharにはfalse）が返されることを確認しています。これにより、Phar::isExecutable()がどのように機能し、Pharファイルの実行可能性を判断するかが明確に示されています。最後に、作成したPharファイルを削除し、phar.readonly設定を元の状態に戻してクリーンアップを行っています。

Copy
1<?php
2
3// このスクリプトは、PHPのPhar拡張機能が有効になっている環境（通常はPHP CLI）で実行する必要があります。
4// Pharファイルの作成を許可するには、php.ini で 'phar.readonly = Off' に設定されているか、
5// または `php -d phar.readonly=0 your_script.php` のように一時的に設定する必要があります。
6
7/**
8 * Phar::isExecutable() メソッドのサンプルコード
9 *
10 * このメソッドは、Pharアーカイブが実行可能（PHP CLIで直接実行できるように設定されている）
11 * かどうかをチェックします。
12 *
13 * システムエンジニアを目指す初心者の方へ:
14 * Pharは、複数のPHPファイルを単一のアーカイブファイルにまとめるための形式です。
15 * これにより、アプリケーションの配布が容易になります。
16 * isExecutable() メソッドは、そのPharファイルがLinuxやmacOSなどのCLI環境で
17 * `./my_app.phar` のように直接実行できる形式になっているかを確認するために使用されます。
18 */
19
20// 一時的なPharファイル名を定義します。
21$pharFileName = 'my_example_app.phar';
22$pharFilePath = __DIR__ . '/' . $pharFileName; // スクリプトと同じディレクトリに作成
23
24// --- 1. クリーンアップ処理 (以前の実行で残ったファイルを削除) ---
25// スクリプトを複数回実行する際に問題が起きないように、既存のファイルを削除します。
26if (file_exists($pharFilePath)) {
27    unlink($pharFilePath);
28    echo "既存のPharファイル '{$pharFileName}' を削除しました。\n";
29}
30// Phar::createDefaultStub()が一時的に '.zip' 拡張子を持つファイルを作成することがあるため
31if (file_exists($pharFilePath . '.zip')) {
32    unlink($pharFilePath . '.zip');
33    echo "既存の一時ファイル '{$pharFileName}.zip' を削除しました。\n";
34}
35
36try {
37    // --- 2. Pharアーカイブの作成 ---
38    // 新しいPharオブジェクトを作成します。
39    // 第一引数: 作成するPharファイルのパス。
40    // 第二引数: フラグ (0はデフォルト)。
41    // 第三引数: アーカイブのエイリアス (内部的な名前)。
42    $phar = new Phar($pharFilePath, 0, $pharFileName);
43
44    // Pharファイルの編集を開始します（バッファリング）。
45    $phar->startBuffering();
46
47    // アーカイブに簡単なPHPファイルを追加します。
48    $phar->addFromString('index.php', '<?php echo "Hello from the Phar archive!";');
49    echo "アーカイブに 'index.php' を追加しました。\n";
50
51    // --- 3. 実行可能なスタブの設定 ---
52    // PharアーカイブがPHP CLIで直接実行されるための「スタブ」を設定します。
53    // スタブは、Pharが実行されたときに最初に実行されるコードです。
54    // createDefaultStub() は、shebang行 (例: #!/usr/bin/env php) と
55    // Pharをロードするための基本的なPHPコードを含むデフォルトのスタブを生成します。
56    $phar->setStub($phar->createDefaultStub('index.php'));
57    echo "Pharアーカイブに実行可能なスタブを設定しました。\n";
58
59    // 編集を終了し、Pharファイルをディスクに保存します。
60    $phar->stopBuffering();
61    echo "Pharファイル '{$pharFileName}' を作成しました。\n";
62
63    // --- 4. Phar::isExecutable() メソッドの呼び出し ---
64    // 作成したPharオブジェクトに対して isExecutable() を呼び出し、
65    // このPharが実行可能であるかどうかをチェックします。
66    // 戻り値は bool (true または false) です。
67    if ($phar->isExecutable()) {
68        echo "Pharファイル '{$pharFileName}' は実行可能です。\n";
69        echo "このPharファイルは、CLIで直接 `php {$pharFileName}` または `./{$pharFileName}` (実行権限付与後) のように実行できます。\n";
70    } else {
71        echo "Pharファイル '{$pharFileName}' は実行可能ではありません。\n";
72    }
73
74} catch (PharException $e) {
75    // Phar関連の操作中にエラーが発生した場合の処理
76    echo "エラー: Phar操作中に問題が発生しました。\n";
77    echo "詳細: " . $e->getMessage() . "\n";
78    echo "ヒント: php.ini で 'phar.readonly = Off' に設定されているか確認してください。\n";
79    echo "ヒント: CLI実行時に `php -d phar.readonly=0 " . basename(__FILE__) . "` のように一時的に設定することも可能です。\n";
80} finally {
81    // --- 5. クリーンアップ処理 (作成したファイルを削除) ---
82    // テストが完了したら、作成したPharファイルを削除します。
83    if (file_exists($pharFilePath)) {
84        unlink($pharFilePath);
85        echo "一時ファイル '{$pharFileName}' を削除しました。\n";
86    }
87}

PHPのPhar::isExecutable()メソッドは、PharアーカイブファイルがPHPのコマンドラインインターフェース（CLI）で直接実行できる形式であるかを判定するために使用されます。Phar（ピーエイチエーアール）は、複数のPHPファイルや関連するアセット（画像、設定ファイルなど）を単一のアーカイブファイルにまとめることで、PHPアプリケーションの配布やデプロイを非常に容易にする仕組みです。

このメソッドは引数を一切取らず、戻り値としてブール値（trueまたはfalse）を返します。具体的には、Pharファイル内に「実行可能なスタブ」と呼ばれる特別なPHPコードブロックが存在するかどうかを確認します。このスタブは、Pharファイルが./my_app.pharのように直接実行された際に、最初に処理される役割を担います。これにより、PharファイルはOSのシェルスクリプトのように振る舞い、内部のPHPアプリケーションを起動できるようになります。

サンプルコードでは、まず一時的なPharファイルを作成し、その中にシンプルなPHPスクリプトを組み込みます。その後、Phar::createDefaultStub()メソッドを使用して、このPharアーカイブが直接実行可能となるためのスタブを内部に設定しています。この設定が完了した状態でPhar::isExecutable()を呼び出すと、スタブが適切に存在することを確認し、trueを返します。これは、作成されたPharファイルが、必要な実行権限を付与すればCLIで直接起動できる状態にあることを示しています。Pharファイルの作成や編集には、PHPの設定ファイル（php.ini）でphar.readonly = Offと設定されているか、実行時に一時的にこの設定を上書きする必要があります。