PHPのPharコンテキストオプションとは？compress・metadataの使い方とコード例

はじめに

Pharは「PHP Archive（PHPアーカイブ）」の略称です。あるPHPアプリケーションやライブラリに含まれるすべてのリソースを、配布しやすいように1つの.pharファイルへパッケージ化できます。このPharファイルは、phar://ラッパーを使うことで入出力（IO）ストリームとして扱うことが可能です。

phar://ラッパーで利用できる主なコンテキストオプションは、以下の2つです。

compress

圧縮形式を指定するためのオプションです。PHPには、圧縮フォーマットを表す次の定義済み定数が用意されています。

metadata

Pharアーカイブに関する付加情報を格納するためのオプションです。説明情報を保持した任意のPHP変数を、Phar::setMetadata()メソッドの引数として渡します。これにより、アーカイブ自体にメタデータを持たせることができます。

使用例

以下は、Pharファイルを作成する際にPharコンテキストオプションを設定するサンプルコードです。stream_context_create()で圧縮形式（gzip）とメタデータを指定し、file_put_contents()でファイルを書き込んでいます。

<?php
$context = stream_context_create(array('phar' =>
array('compress' => Phar::GZ)),
array('metadata' => array('user' => 'cellog')));
file_put_contents('phar://my.phar/somefile.php', 0, $context);
?>