PHP phar://ストリームラッパーとは？Pharアーカイブの作成と実行方法を解説

はじめに

phar:// ストリームラッパーは、PHP 5.3.0 以降のすべてのバージョンで利用できます。Phar は PHP Archive（PHPアーカイブ） の略で、PHP アプリケーションやライブラリをひとつのファイルにまとめて配布するために使用され、通常の PHP ファイルとして直接実行することも可能です。

phar:// ラッパーは、fopen() による読み書きモードでのファイルオープンやファイル名の変更、opendir() によるディレクトリストリーム操作のほか、ディレクトリの作成・削除といった操作にも対応しています。また、Phar クラスを使えば、ディレクトリ内に配置したアプリケーションのリソース群をひとつの phar アーカイブへ簡単にパッケージ化でき、読み取り時にはこのアーカイブを phar:// ラッパー経由で参照します。

Pharアーカイブの作成方法

まず、php.ini の phar.readonly 設定を 0 に変更しておきます。この設定はデフォルトで有効（1）になっており、アーカイブの作成・更新を行う場合は無効にする必要があります。なお、読み取りだけであれば設定を変更する必要はありません。

次に、アプリケーションのリソースをすべて格納する src フォルダを作成し、その中にエントリポイントとなる index.php ファイルを用意します。

<?php
echo "phar application started";
?>

続いて、Phar クラスのオブジェクトを生成し、buildFromDirectory() メソッドを使って src フォルダ内のファイル一式を含む phar アーカイブを作成します。さらに setDefaultStub() で、すべてのクラスを読み込むメインファイルとして index.php を指定します。

<?php
// php.ini の phar.readonly を 0 に設定しておく必要があります
$pharFile = 'app.phar';
// 既存ファイルのクリーンアップ
if (file_exists($pharFile)) {
    unlink($pharFile);
}
if (file_exists($pharFile . '.gz')) {
    unlink($pharFile . '.gz');
}
// phar アーカイブの作成
$p = new Phar($pharFile);
// ディレクトリ全体からライブラリを構築
$p->buildFromDirectory('src/');
// エントリポイントとなるメインファイルを指定
$p->setDefaultStub('index.php', '/index.php');
// おまけ：gzip 形式で圧縮
$p->compress(Phar::GZ);
echo "$pharFile successfully created";
?>

上記のスクリプトをコマンドラインから実行します。

php create-phar.php

これにより、作業ディレクトリ内に app.phar が生成されます。作成した phar アーカイブを実行するには、次のコマンドを使用します。

php app.phar

phar://ラッパーの使用例

phar:// ラッパーを使うと、アーカイブ内部のファイルに通常のファイルと同じ要領でアクセスできます。以下の例では、app.phar 内の index.php の内容を読み出して表示しています。

<?php
echo file_get_contents('phar://app.phar/index.php');
?>

このコードを実行すると、index.php ファイルの中身が出力されます。

セキュリティ上の注意点

phar:// ラッパーは非常に便利である一方、セキュリティ面での留意も欠かせません。phar アーカイブにはシリアライズされたメタデータが含まれており、ユーザー入力経由で phar:// URL にアクセスできる構成の場合、メタデータの自動的なデシリアライズを起点とする攻撃（いわゆる POP チェーン攻撃）が知られています。信頼できない入力値をファイル操作関数に渡さない設計を心がけ、アーカイブの提供元が信頼できる場合にのみ phar:// 経由のアクセスを許可することが推奨されます。