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

Copy
1<?php
2
3// このサンプルコードはPHP CLI (コマンドラインインターフェース) での実行を想定しています。
4// Pharアーカイブの作成には、php.ini設定の 'phar.readonly' が 'Off' である必要があります。
5// サーバー環境によっては 'phar.readonly' が 'On' の場合があるため、ご注意ください。
6
7// 一時ディレクトリとPHARファイル名の設定
8$pharFileName = 'example_application.phar';
9$tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'phar_example_' . uniqid();
10$pharFilePath = $tempDir . DIRECTORY_SEPARATOR . $pharFileName;
11
12// PHARアーカイブに含めるためのダミーファイルを作成
13if (!is_dir($tempDir)) {
14    mkdir($tempDir, 0777, true);
15}
16file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'index.php', '<?php echo "Hello from PHAR!";');
17file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'config.php', '<?php return ["app_name" => "Example App"];');
18
19$phar = null; // Pharオブジェクトをnullで初期化し、finallyブロックで確実に解放できるようにする
20
21try {
22    // php.ini の 'phar.readonly' 設定をチェック
23    if (ini_get('phar.readonly') == '1') {
24        echo "エラー: php.ini の 'phar.readonly' が 'On' に設定されているため、PHARアーカイブを作成できません。\n";
25        echo "このサンプルコードを実行するには、'phar.readonly' を 'Off' に設定してください。\n";
26        exit(1);
27    }
28
29    // PHARアーカイブを作成します。
30    // Laravelのような大規模なアプリケーションやフレームワークも、PHAR形式でパッケージングすることで
31    // 単一の実行可能ファイルとして配布されることがあります。
32    // このステップは、Phar::getRealPath() をデモンストレーションするために、PHARファイルを作成するものです。
33    $phar = new Phar($pharFilePath);
34    // PHARアーカイブを圧縮なしで作成
35    $phar->buildFromDirectory($tempDir);
36    // PHARの実行時に使用されるスタブ（エントリポイント）を設定
37    $phar->setStub('<?php Phar::mapPhar("' . $pharFileName . '"); include "index.php"; __HALT_COMPILER(); ?>');
38
39    echo "PHARアーカイブが正常に作成されました: " . $pharFilePath . "\n";
40
41    // Phar::getRealPath() メソッドの使用
42    // このメソッドは、Pharアーカイブファイルがファイルシステム上のどこに存在するかを示す、
43    // その実際のパス（絶対パス）を文字列で返します。
44    // 例えば、もしLaravelアプリケーションがPHARファイルとして配布され、どこかに展開された場合、
45    // そのPHARアーカイブ自体の物理的な場所を正確に知る必要がある際に、このメソッドが役立ちます。
46    $realPath = $phar->getRealPath();
47
48    echo "Phar::getRealPath() によって取得されたパス: " . $realPath . "\n";
49
50    // 取得されたパスと、実際に作成されたファイルのパスを比較して検証
51    if (realpath($pharFilePath) === $realPath) {
52        echo "検証成功: getRealPath() は期待されるパスを返しました。\n";
53    } else {
54        echo "検証失敗: getRealPath() が返したパスが期待と異なります。\n";
55        echo "期待されるパス: " . realpath($pharFilePath) . "\n";
56    }
57
58} catch (PharException $e) {
59    echo "PHAR操作中にエラーが発生しました: " . $e->getMessage() . "\n";
60} finally {
61    // クリーンアップ処理
62    // 作成したPharオブジェクトを解放し、PHARアーカイブと一時ディレクトリを削除します。
63    if ($phar !== null) {
64        unset($phar); // Pharオブジェクトを解放
65    }
66
67    // PHARファイルを削除
68    if (file_exists($pharFilePath)) {
69        // Phar::unlinkArchive() を使用すると、PHPプロセスがファイルをロックしていても安全に削除できます。
70        Phar::unlinkArchive($pharFilePath);
71        echo "PHARアーカイブが削除されました。\n";
72    }
73
74    // 一時ディレクトリ内のダミーファイルを削除し、ディレクトリを削除
75    if (is_dir($tempDir)) {
76        unlink($tempDir . DIRECTORY_SEPARATOR . 'index.php');
77        unlink($tempDir . DIRECTORY_SEPARATOR . 'config.php');
78        rmdir($tempDir);
79        echo "一時ディレクトリがクリーンアップされました。\n";
80    }
81}

Phar::getRealPath()は、PHPのPhar（PHP Archive）クラスに属するメソッドで、Pharアーカイブファイルがファイルシステム上のどこに存在するかを示す、その実際のパス（絶対パス）を文字列として取得します。このメソッドは引数を取りません。

Pharアーカイブは、複数のPHPファイルや関連リソースを単一のアーカイブファイルにまとめる機能で、PHPアプリケーションを単一ファイルとして配布する際に利用されます。例えば、Laravelのような大規模なフレームワークがPHAR形式で配布される場合、その実行中のPHARアーカイブ自体の物理的な場所を正確に知る必要がある際に、getRealPath()が役立ちます。

提供されたサンプルコードでは、まず一時ディレクトリにダミーファイルを作成し、PHPの設定phar.readonlyがオフであることを確認した上で、それらのファイルを含むexample_application.pharというPharアーカイブを生成しています。次に、作成されたPharオブジェクトに対してgetRealPath()を呼び出し、その戻り値が実際にファイルシステム上に存在するPharファイルの絶対パスと一致するかを検証しています。これにより、getRealPath()がアーカイブの正確な物理パスを返すことを具体的に示しています。最後に、作成したPharアーカイブと一時ディレクトリを適切にクリーンアップしています。