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

convertToDataメソッドは、既存のPharアーカイブを別のデータアーカイブ形式に変換するメソッドです。

Pharは、複数のファイルを一つのアーカイブにまとめ、単一ファイルとして配布・実行できるPHPの仕組みです。このconvertToDataメソッドは、通常PHPスクリプトとして実行可能な.phar形式のPharアーカイブを、その実行能力を持たない.tar形式や.zip形式などのデータアーカイブに変換します。

この変換により、アーカイブはPHPの実行特性を失い、含まれるファイルを単一のパッケージとして管理するデータコンテナとして扱われるようになります。例えば、ウェブアプリケーションのソースコードをPhar形式で配布している場合に、後から汎用的なデータアーカイブとして再配布したいといったシナリオで役立ちます。

変換処理では、元のPharファイルは削除され、指定された新しい形式のデータアーカイブが新たに作成されます。変換先のアーカイブ形式は、メソッドの引数としてPhar::TAR定数やPhar::ZIP定数などで指定します。この操作を実行するには、元のPharアーカイブファイルに対する書き込み権限が必要です。

Copy
1<?php
2$pharDataArchive = $phar->convertToData(Phar::TAR, Phar::GZ, '.tar.gz');

int $format = 0, int $compression = 0, string $extension = ''

• int $format = 0: 変換後のPharアーカイブのフォーマットを指定する整数。0はPhar::PHAR、1はPhar::ZIP。
• int $compression = 0: 圧縮方法を指定する整数。0はPhar::NONE、1はPhar::GZ、2はPhar::BZ2。
• string $extension = '': 変換後のPharアーカイブのファイル拡張子を指定する文字列。

PharData

このメソッドは、現在のPharアーカイブをPharDataオブジェクトに変換して返します。