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

Copy
1<?php
2
3/**
4 * このスクリプトは、Pharアーカイブを作成し、画像ファイルを含むいくつかのファイルをそこに追加した後、
5 * Pharアーカイブ全体をGzip形式で圧縮する方法を示します。
6 *
7 * キーワード「php compress image」は通常、個々の画像ファイル自体のサイズを最適化する意味合いが強いですが、
8 * Phar::compress() メソッドはPharアーカイブ全体を圧縮するものです。
9 * ここでは、画像ファイルをPharアーカイブに含め、そのアーカイブを圧縮する例として示します。
10 */
11
12// Phar拡張機能がロードされているかを確認します。
13// ロードされていない場合、php.iniで 'extension=phar' を有効にする必要があります。
14if (!extension_loaded('phar')) {
15    die("エラー: Phar拡張機能がロードされていません。php.iniを確認してください。\n");
16}
17
18// Pharアーカイブへの書き込みを許可するために 'phar.readonly' 設定を一時的に変更します。
19// 本番環境では通常、php.ini で 'phar.readonly = 0' を設定するか、Pharアーカイブをビルドする専用のスクリプトを使用します。
20ini_set('phar.readonly', 0);
21
22// --- サンプル用のファイル名とPharアーカイブ名を定義 ---
23$pharFileName = 'my_application.phar'; // 作成するPharアーカイブ名
24$imageFileName = 'sample_photo.jpg'; // Pharに追加するダミー画像ファイル名
25$textFileName = 'readme.txt';        // Pharに追加するダミーテキストファイル名
26$compressedPharFileName = $pharFileName . '.gz'; // 圧縮後のPharアーカイブ名 (Phar::GZの場合)
27
28
29// --- クリーンアップ: 以前の実行で作成されたファイルを削除 ---
30// スクリプトが複数回実行された場合に備え、既存のPharアーカイブやダミーファイルを削除します。
31if (file_exists($pharFileName)) {
32    unlink($pharFileName);
33}
34if (file_exists($compressedPharFileName)) {
35    unlink($compressedPharFileName);
36}
37if (file_exists($imageFileName)) {
38    unlink($imageFileName);
39}
40if (file_exists($textFileName)) {
41    unlink($textFileName);
42}
43
44// --- ダミーファイルを作成 ---
45// Pharアーカイブに追加するためのサンプルコンテンツを持つダミーファイルを作成します。
46// 実際のシナリオでは、ここに実際の画像データやアプリケーションコードが含まれます。
47file_put_contents($imageFileName, 'ダミー画像データ (これは実際のJPEGデータではありませんが、ファイルを作成するために使用します)');
48file_put_contents($textFileName, "これはPharアーカイブに含まれるサンプルテキストファイルです。\nPharは複数のファイルを1つのアーカイブにまとめるのに役立ちます。");
49
50echo "Pharアーカイブの作成と圧縮プロセスを開始します。\n\n";
51
52try {
53    // --- 1. Pharアーカイブの作成 ---
54    // 新しいPharアーカイブを初期化します。
55    // コンストラクタにファイルパスを渡すと、その名前でPharファイルが作成されます。
56    $phar = new Phar($pharFileName);
57
58    // Pharファイルを編集可能な状態にするためにバッファリングを開始します。
59    // これを行うことで、複数のファイルを追加したり、圧縮設定を変更したりできます。
60    $phar->startBuffering();
61
62    // --- 2. ファイルをPharアーカイブに追加 ---
63    // 先ほど作成したダミーファイルをPharアーカイブに追加します。
64    // addFile() メソッドの第1引数はローカルファイルのパス、第2引数はアーカイブ内でのパスです。
65    $phar->addFile($imageFileName, 'assets/' . $imageFileName); // 画像ファイルを 'assets' ディレクトリとして追加
66    $phar->addFile($textFileName, $textFileName);                 // テキストファイルをルートとして追加
67
68    echo "Pharアーカイブ ('" . $pharFileName . "') にファイルを追加しました。\n";
69    echo "圧縮前のアーカイブサイズ: " . filesize($pharFileName) . " バイト\n\n";
70
71    // --- 3. Pharアーカイブを圧縮 ---
72    // Phar::compress() メソッドを使用して、Pharアーカイブ全体を圧縮します。
73    // 引数には、どの圧縮形式を使用するかを指定します（例: Phar::GZ、Phar::BZ2、Phar::NONE）。
74    // このメソッドは戻り値を持ちません（void）。圧縮が成功すると、指定された形式で新しいPharファイルが作成されます。
75    // ここではGzip圧縮（Phar::GZ）を選択します。これにより、元のPharファイルに '.gz' 拡張子が付いた新しいファイルが作成されます。
76    $phar->compress(Phar::GZ);
77
78    // バッファリングを終了し、変更をPharファイルに書き込みます。
79    $phar->stopBuffering();
80
81    echo "PharアーカイブがGzip形式で圧縮されました。\n";
82    // 圧縮後のファイルサイズを確認します。
83    if (file_exists($compressedPharFileName)) {
84        echo "圧縮後のアーカイブ ('" . $compressedPharFileName . "') サイズ: " . filesize($compressedPharFileName) . " バイト\n";
85    } else {
86        echo "エラー: 圧縮済みPharアーカイブ ('" . $compressedPharFileName . "') が見つかりませんでした。\n";
87    }
88
89} catch (Exception $e) {
90    // エラーが発生した場合、メッセージを表示します。
91    echo "エラーが発生しました: " . $e->getMessage() . "\n";
92} finally {
93    // --- クリーンアップ ---
94    // スクリプトの実行が完了したら、作成されたファイルとアーカイブを削除します。
95    // これは、テストやサンプルコードで一時ファイルを残さないための良い習慣です。
96    if (file_exists($imageFileName)) {
97        unlink($imageFileName);
98    }
99    if (file_exists($textFileName)) {
100        unlink($textFileName);
101    }
102    // 元の非圧縮Pharファイルも削除します。
103    if (file_exists($pharFileName)) {
104        unlink($pharFileName);
105    }
106    // 圧縮されたPharファイルも削除します。
107    if (file_exists($compressedPharFileName)) {
108        unlink($compressedPharFileName);
109    }
110    echo "\nクリーンアップが完了しました。すべてのサンプルファイルが削除されました。\n";
111}

PHPのPhar::compressメソッドは、Pharアーカイブ全体を特定の圧縮形式で圧縮するために使用されます。Pharは、複数のファイル（アプリケーションコード、設定ファイル、画像など）を1つのアーカイブファイルにまとめるための拡張機能です。このメソッドを利用することで、アーカイブのサイズを削減し、ディスクスペースの節約や配布の効率化が図れます。

引数$compressionには、圧縮形式を指定する定数（例: Phar::GZでGzip圧縮、Phar::BZ2でBzip2圧縮）を渡します。オプションの引数$extensionは、圧縮後のファイル名に付与する拡張子を指定しますが、通常は圧縮形式に基づいて自動的に決定されるため省略可能です。このメソッドは戻り値を持ちません（void）。圧縮が成功すると、元のPharファイルは削除され、指定された圧縮形式で新しいPharファイルが生成されます。

サンプルコードは、まず空のPharアーカイブを作成し、ダミーの画像ファイルとテキストファイルをその中に格納します。その後、Phar::compress(Phar::GZ)を呼び出すことで、作成されたPharアーカイブ全体をGzip形式で圧縮する手順を示しています。「php compress image」というキーワードは個々の画像ファイル自体のサイズ最適化を指すことが多いですが、Phar::compressは画像を含むアーカイブ全体を圧縮する点が異なります。

Copy
1<?php
2
3/**
4 * Pharアーカイブを作成し、指定された形式で圧縮するサンプル関数。
5 * システムエンジニアを目指す初心者向けに、Phar::compressメソッドの使用法を示します。
6 *
7 * @param string $archiveName 作成するPharアーカイブのファイル名 (例: 'my_app.phar')
8 * @param int $compressionType 圧縮タイプ (Phar::GZ または Phar::BZ2)
9 * @return bool 成功した場合はtrue、失敗した場合はfalse
10 */
11function createAndCompressPharArchive(string $archiveName, int $compressionType): bool
12{
13    // Pharアーカイブの作成・変更を許可するため、phar.readonly設定を一時的に無効にします。
14    // この設定は通常php.iniで指定され、本番環境ではセキュリティ上の理由から 'on' にすることが強く推奨されます。
15    // スクリプト内で一時的に変更する場合は、開発・テスト用途に限定し、十分に注意して使用してください。
16    ini_set('phar.readonly', 0);
17
18    $basePath = __DIR__;
19    $fullArchivePath = $basePath . DIRECTORY_SEPARATOR . $archiveName;
20    $compressedFileExtension = '';
21
22    // 圧縮タイプに応じた出力ファイルの拡張子を決定します。
23    // Phar::compressは元のファイル名にこの拡張子を追加します。
24    switch ($compressionType) {
25        case Phar::GZ:
26            $compressedFileExtension = '.gz';
27            echo "圧縮形式: GZIP\n";
28            break;
29        case Phar::BZ2:
30            $compressedFileExtension = '.bz2';
31            // BZ2圧縮を使用するには、PHPにbz2拡張がロードされている必要があります。
32            if (!extension_loaded('bz2')) {
33                echo "エラー: BZ2拡張がロードされていません。php.iniで 'extension=bz2' を有効にしてください。\n";
34                return false;
35            }
36            echo "圧縮形式: BZ2\n";
37            break;
38        default:
39            echo "エラー: サポートされていない圧縮タイプが指定されました。Phar::GZ または Phar::BZ2 を使用してください。\n";
40            return false;
41    }
42
43    $compressedArchivePath = $fullArchivePath . $compressedFileExtension;
44
45    // サンプル用にアーカイブする一時ファイルを作成します。
46    $tempFile1 = $basePath . DIRECTORY_SEPARATOR . 'sample_file1.txt';
47    $tempFile2 = $basePath . DIRECTORY_SEPARATOR . 'sample_file2.txt';
48    file_put_contents($tempFile1, 'This is the first sample file content.');
49    file_put_contents($tempFile2, 'This is the second sample file content.');
50
51    echo "Pharアーカイブの準備を開始します。\n";
52
53    // 既存のPharアーカイブファイルおよび圧縮されたファイルを削除して、クリーンな状態にします。
54    foreach ([$fullArchivePath, $compressedArchivePath] as $file) {
55        if (file_exists($file)) {
56            unlink($file);
57            echo "既存のファイル '{$file}' を削除しました。\n";
58        }
59    }
60
61    try {
62        // 新しいPharアーカイブオブジェクトを作成します。
63        // 引数には、作成するPharアーカイブのフルパスを指定します。
64        $phar = new Phar($fullArchivePath);
65
66        // Pharアーカイブへの変更をバッファリングします。
67        // これにより、複数のファイル追加を一度に処理できます。
68        $phar->startBuffering();
69
70        // 作成した一時ファイルをPharアーカイブに追加します。
71        // addFileの第2引数で、アーカイブ内でのファイルのパスを指定できます。
72        $phar->addFile($tempFile1, 'project/files/file1.txt');
73        $phar->addFile($tempFile2, 'project/files/file2.txt');
74
75        // バッファリングを終了し、アーカイブへの変更をコミットします。
76        $phar->stopBuffering();
77
78        echo "Pharアーカイブ '{$archiveName}' が作成されました (非圧縮状態)。\n";
79        echo "非圧縮サイズ: " . round(filesize($fullArchivePath) / 1024, 2) . " KB\n";
80
81        // Pharアーカイブをcompressメソッドで圧縮します。
82        // このメソッドが成功すると、元の非圧縮アーカイブファイルは削除され、
83        // 圧縮された新しいファイル (例: my_app.phar.gz) が作成されます。
84        // 引数の `$extension` はNULLのままで、Pharが自動的に適切な拡張子を追加します。
85        $phar->compress($compressionType);
86
87        if (file_exists($compressedArchivePath)) {
88            echo "Pharアーカイブが {$compressedFileExtension} 形式で正常に圧縮されました: '{$compressedArchivePath}'\n";
89            echo "圧縮後サイズ: " . round(filesize($compressedArchivePath) / 1024, 2) . " KB\n";
90            return true;
91        } else {
92            echo "エラー: 圧縮されたアーカイブファイル '{$compressedArchivePath}' が見つかりませんでした。\n";
93            return false;
94        }
95    } catch (PharException $e) {
96        // Phar関連のエラーを捕捉します。
97        echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
98        return false;
99    } catch (Exception $e) {
100        // その他の一般的なエラーを捕捉します。
101        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
102        return false;
103    } finally {
104        // 処理の成功・失敗に関わらず、一時ファイルや中間ファイルをクリーンアップします。
105        echo "一時ファイルのクリーンアップ中...\n";
106        if (file_exists($tempFile1)) {
107            unlink($tempFile1);
108        }
109        if (file_exists($tempFile2)) {
110            unlink($tempFile2);
111        }
112        // compress()が成功した場合、元の$fullArchivePathは削除されているはずです。
113        // 失敗した場合に備えて念のためチェックして削除します。
114        if (file_exists($fullArchivePath)) {
115             unlink($fullArchivePath);
116        }
117        echo "クリーンアップが完了しました。\n";
118    }
119}
120
121// --------------------------------------------------------------------------------
122// サンプルコードの実行例
123// --------------------------------------------------------------------------------
124
125// GZIP圧縮を使用してPharアーカイブを作成・圧縮する例
126echo "--- GZIP圧縮の例 ---\n";
127if (createAndCompressPharArchive('my_application_gzip.phar', Phar::GZ)) {
128    echo "GZIP圧縮アーカイブの作成・圧縮に成功しました。\n\n";
129} else {
130    echo "GZIP圧縮アーカイブの作成・圧縮に失敗しました。\n\n";
131}
132
133// BZ2圧縮を使用してPharアーカイブを作成・圧縮する例
134// 注: BZ2圧縮を使用するには、PHPがbz2拡張をロードしている必要があります。
135// php.iniで 'extension=bz2' を有効にしてください。
136echo "--- BZ2圧縮の例 ---\n";
137if (createAndCompressPharArchive('my_application_bz2.phar', Phar::BZ2)) {
138    echo "BZ2圧縮アーカイブの作成・圧縮に成功しました。\n\n";
139} else {
140    echo "BZ2圧縮アーカイブの作成・圧縮に失敗しました。\n\n";
141}
142

Phar::compress メソッドは、PHPアプリケーションを単一のアーカイブファイルとして配布するためのPhar形式で作成されたアーカイブを、指定された圧縮形式で圧縮する機能を提供します。これにより、アーカイブのファイルサイズを削減し、配布や転送を効率的に行えます。

このメソッドは、第一引数 $compression で圧縮タイプを指定します。ここには、Pharクラスの定数である Phar::GZ (GZIP圧縮) または Phar::BZ2 (BZIP2圧縮) のいずれかを指定します。第二引数 $extension はオプションであり、通常は NULL のままで使用します。NULL を指定すると、Pharが自動的に圧縮形式に応じたファイル拡張子 (例: .gz, .bz2) をアーカイブファイル名に追加します。

compress メソッド自体は戻り値を返しません。メソッドの実行が成功すると、元の非圧縮Pharアーカイブファイルは削除され、指定された圧縮形式で新しい圧縮済みファイルが同じパスに生成されます。

サンプルコードでは、まず ini_set('phar.readonly', 0) を使ってPharアーカイブの作成・変更を一時的に許可しています。これは開発・テスト環境で必要な設定ですが、本番環境では注意が必要です。その後、一時的なサンプルファイルを作成し、新しいPharアーカイブにこれらを追加します。最後に Phar::compress メソッドを呼び出し、アーカイブ全体をGZIPまたはBZ2形式で圧縮する一連の流れを示しています。圧縮前後のファイルサイズ比較や、エラーハンドリング、一時ファイルのクリーンアップ処理も含まれており、実用的な例として参考になります。