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

decompressFilesメソッドは、Pharアーカイブ内に含まれるファイルの圧縮を解除するメソッドです。Pharは、PHPアプリケーションやライブラリを構成する複数のファイルを、一つのアーカイブファイルとしてまとめるための特殊な形式です。このdecompressFilesメソッドは、そのPharアーカイブの中に格納されている個々のファイルがGzipまたはBzip2といった形式で圧縮されている場合に、それらをオリジナルの未圧縮状態に戻す処理を実行します。

このメソッドが特に重要なのは、Pharアーカイブ 自体 の圧縮状態を変更するのではなく、アーカイブ 内 の個々のファイルのみに作用する点です。これにより、Pharファイル全体のサイズは維持しつつも、内部のファイルを読み込む際のパフォーマンスを向上させたり、特定の処理で未圧縮データが必要な場合に柔軟に対応したりすることが可能になります。

この機能を正しく利用するためには、PHPの設定オプションであるphar.readonlyが0（書き込み可能）に設定されている必要があります。メソッドの実行により、Pharアーカイブ内の圧縮されたファイルは一括で未圧縮の状態に変換され、その操作の成否はブール値で返されます。このメソッドは、Pharアーカイブ内のコンテンツを効率的に管理するために利用されます。

Copy
1<?php
2$phar = new Phar('path/to/archive.phar');
3$phar->decompressFiles();
4?>

array $files, ?string $extension = null

• array $files: 圧縮解除するファイルパスの配列
• ?string $extension = null: 圧縮解除する際に使用する圧縮形式を指定します。指定しない場合は、Phar::detectDependencies()によって自動的に検出されます。

bool

Phar::decompressFilesメソッドは、pharアーカイブ内のファイルを解凍する処理の成否を真偽値（bool）で返します。成功した場合は true を、失敗した場合は false を返します。