1. 導入
PHPで開発を行う際、ライブラリの管理にはComposerが一般的ですが、配布物や単一ファイルでの実行環境を構築したい場合、`Phar (PHP Archive)`という仕組みが非常に強力です。JavaにおけるJARファイルのように、PHPスクリプトやリソースを一つのアーカイブにまとめることで、デプロイや配布の利便性が飛躍的に向上します。今回は、Pharの基本的な仕組みと、実務で役立つ作成方法を解説します。
2. 基礎知識
`Phar`は、PHP 5.3以降で標準搭載されたアーカイブ形式です。最大の特徴は、WebサーバーやCLIから直接実行可能な「実行可能アーカイブ」を作成できる点です。これにより、膨大なソースコードをディレクトリ構造のままコピーするのではなく、一つのファイルとして配布・読み込みが可能です。
また、`Phar`には「スタブ（Stub）」と呼ばれる、アーカイブ読み込み時に最初に実行されるファイルが含まれており、これによってアーカイブ単体でのエントリーポイントを定義できます。
3. 実装/解決策
Pharを作成するには、`Phar`クラスを使用します。作成には`php.ini`で`phar.readonly`の設定が`Off`になっている必要があるため、事前に確認してください。
手順は以下の通りです。
1. `Phar`オブジェクトをインスタンス化する。
2. `buildFromDirectory`などで対象ファイルを追加する。
3. `setStub`で実行時のエントリーポイントを指定する。
4. サンプルプログラム
以下のコードは、`src`ディレクトリの中身を`app.phar`という一つのファイルにまとめるスクリプトです。
buildFromDirectory(dirname(__FILE__) . ‘/src’);
// アーカイブ実行時に呼び出されるスタブを設定
// ここではsrc/index.phpをエントリーポイントとして指定
$defaultStub = $phar->createDefaultStub(‘index.php’);
$phar->setStub(“#!/usr/bin/env php\n” . $defaultStub);
echo “Pharファイルの作成が完了しました。\n”;
?>
5. 応用・注意点
注意点1：phar.readonly設定
開発環境でPharを作成する際、`php.ini`で`phar.readonly = On`になっていると実行時にエラーになります。本番環境へのデプロイ時にはセキュリティのため`On`にすべきですが、ビルドプロセスでは注意してください。
注意点2：依存ライブラリの扱い
Composerでインストールした`vendor`ディレクトリも含めてPhar化する場合、オートローダーのパス解決が重要になります。スタブ内で`require ‘phar://app.phar/vendor/autoload.php’;`のように読み込むことで、アーカイブ内でもクラスオートロードを正しく機能させることができます。
現場での活用法
CLIツールや、設定ファイルを含めたパッケージを配布する際に非常に有効です。ただし、書き込みが発生するログなどはアーカイブ外に出す設計にするなど、Pharの「読み取り専用」特性を活かしたディレクトリ構成を心がけましょう。