【php8上級/準上級試験】模擬問題解説 問題27 Phar __HALT_COMPILER()

phar 拡張モジュールは、PHP アプリケーション全体をひとつの “phar” (PHP Archive) ファイルにまとめて配布やインストールを容易にするためのものである。
例えば、PHP で最近よく使われている Composer が Phar で配布されている。
そのため、composer.phar の中は

# !/usr/bin/env php

という書き出しになっている。
また、中身が PHP ファイルなので、ファイルに実行権限がなくても

php composer.phar
のコマンドラインで動かす事ができる。

phar のスタブには __HALT_COMPILER() という関数が使われている。
__HALT_COMPILER() は「コンパイラの実行を中止する」関数である。この関数以降はコンパイルされる事がなく、インストール用ファイルのようなデータを PHP スクリプトに埋め込んでいる場合等に使われる。
そのため、以下のコード

echo 'test', PHP_EOL;
__HALT_COMPILER();
;
dummy data
hoge

を実行すると、結果は次のとおりとなる。

Parse error: syntax error, unexpected identifier “data” in …

しかし以下のコード

echo 'test', PHP_EOL;
__HALT_COMPILER();
;
dummy data;
hoge;

を実行すると、結果は次のとおりとなる。

test

phar のファイルを作る場合は、Phar クラスを用いる。
そのため、hoge.php というファイル名で

class Hoge {
private $i = 999;
}
がある前提で、以下のコード

$obj = new Phar('./exam.phar');
$obj->addFile('hoge.php');

を実行すると exam.phar ができあがる。

ただし php.ini の phar.readonly が 0 でない時は、結果は次のとおりとなる。

Fatal error: Uncaught UnexpectedValueException: creating archive “./exam.phar” disabled by the php.ini setting phar.readonly in …

phar のファイルを使う場合には、Phar ストリームラッパーを使う。
Phar ストリームラッパーは phar:// から始まる。
そのため、先ほど作成した exam.phar がある前提で、以下のコード

require_once('phar://exam.phar/hoge.php');
$obj = new Hoge();
var_dump($obj);

を実行すると、結果は次のとおりとなる。

object(Hoge)#1 (1) {
[“i”:”Hoge”:private]=>
int(999)
}