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

Copy
1<?php
2
3/**
4 * PharFileInfo::isCompressed() の使用例と、PHPの非推奨機能に関する注意点を説明します。
5 *
6 * このスクリプトは、Pharアーカイブ内に圧縮されたファイルと非圧縮のファイルを作成し、
7 * それぞれのファイルの圧縮状態を PharFileInfo::isCompressed() メソッドで確認します。
8 *
9 * 【重要】Pharアーカイブの作成には、php.iniで 'phar.readonly = 0' が設定されている必要があります。
10 *         もし設定されていない場合、PharExceptionが発生し、アーカイブの作成ができません。
11 *         この設定は、運用環境では通常 '1' に設定されています。
12 */
13function demonstratePharIsCompressed(): void
14{
15    $pharPath = __DIR__ . '/my_archive.phar'; // 一時的なPharアーカイブファイル名
16
17    // 既存のPharファイルを削除し、クリーンな状態でテストを開始
18    if (file_exists($pharPath)) {
19        unlink($pharPath);
20    }
21    // アーカイブ全体が圧縮された可能性も考慮して削除
22    if (file_exists($pharPath . '.gz')) {
23        unlink($pharPath . '.gz');
24    }
25
26    $phar = null; // finallyブロックでのクリーンアップのためにnull初期化
27
28    try {
29        // ----------------------------------------------------
30        // Pharアーカイブの作成フェーズ
31        // ----------------------------------------------------
32        // PharDataはPharを継承しており、書き込み可能なPharアーカイブを扱う際に便利です。
33        // 指定したパスに新しいPharアーカイブを作成します。
34        $phar = new PharData($pharPath);
35
36        // 非圧縮ファイルをアーカイブに追加する設定
37        // Phar::setCompression(Phar::NONE) を設定することで、
38        // 以降に addFromString() や addFile() で追加されるファイルは個別に圧縮されなくなります。
39        $phar->setCompression(Phar::NONE);
40        $phar->addFromString(
41            'uncompressed_file.txt',
42            'This is an uncompressed file. Its content will not be compressed within the archive.'
43        );
44        echo "非圧縮ファイル 'uncompressed_file.txt' を追加しました。\n";
45
46        // 圧縮ファイルをアーカイブに追加する設定
47        // Phar::setCompression(Phar::GZ) を設定することで、
48        // 以降に addFromString() や addFile() で追加されるファイルはGZIP形式で個別に圧縮されます。
49        $phar->setCompression(Phar::GZ);
50        $phar->addFromString(
51            'compressed_file.txt',
52            'This is a compressed file. Its content will be compressed within the archive using GZIP. ' .
53            'This file content needs to be long enough to demonstrate compression effectively, so we repeat this line multiple times. ' .
54            'This file content needs to be long enough to demonstrate compression effectively, so we repeat this line multiple times. ' .
55            'This file content needs to be long enough to demonstrate compression effectively, so we repeat this line multiple times.'
56        );
57        echo "圧縮ファイル 'compressed_file.txt' を追加しました。\n";
58
59        // アーカイブ全体を圧縮しない設定（個々のファイルの圧縮とは別）
60        // これにより、my_archive.phar.gz のようなファイルは作成されません。
61        $phar->compress(Phar::NONE);
62
63        // Pharオブジェクトを解放し、ファイルハンドルを閉じます。
64        // これにより、Pharファイルがディスクに完全に書き込まれます。
65        unset($phar);
66
67        echo "\nPharアーカイブ '{$pharPath}' が作成されました。\n";
68
69        // ----------------------------------------------------
70        // 作成したPharアーカイブを開き、ファイルの圧縮状態を確認するフェーズ
71        // ----------------------------------------------------
72        // 作成したPharアーカイブを読み込みモードで再度開きます。
73        $phar = new PharData($pharPath);
74
75        echo "\n--- Pharアーカイブ内のファイル状態を確認 ---\n";
76
77        // アーカイブ内の各ファイルをループ処理
78        foreach ($phar as $file) {
79            // PharFileInfoオブジェクトを通じて、isCompressed() メソッドで個々のファイルが
80            // アーカイブ内で圧縮されているかを確認します。
81            if ($file->isCompressed()) {
82                echo "- " . $file->getFilename() . ": 圧縮されています (Compressed)\n";
83            } else {
84                echo "- " . $file->getFilename() . ": 圧縮されていません (Not Compressed)\n";
85            }
86        }
87
88        // ----------------------------------------------------
89        // PHPの非推奨機能に関する補足 (キーワード: php is deprecated への対応)
90        // ----------------------------------------------------
91        echo "\n--- PHPの非推奨機能に関する補足 ---\n";
92        echo "PHPのバージョンアップに伴い、古い関数や機能が非推奨 (deprecated) となったり、削除されたりすることがあります。\n";
93        echo "システムエンジニアを目指す上で、このような変更点を把握し、最新のベストプラクティスに従うことは重要です。\n";
94        echo "\nPhar関連では、Phar::isValidPharFilename() 関数がPHP 8.0で非推奨 (deprecated) となりました。\n";
95        echo "これはPharファイル名が有効かどうかをチェックする関数でしたが、より安全で柔軟なファイルパスの検証方法が推奨されるようになりました。\n";
96        echo "一方、PharFileInfo::isCompressed() はPHP 8においても引き続き推奨される機能であり、現在のバージョンで問題なく使用できます。\n";
97        echo "このように、PHPコミュニティは継続的に言語を改善し、より良い方法を導入しています。\n";
98
99    } catch (PharException $e) {
100        echo "PharException: " . $e->getMessage() . "\n";
101        echo "Pharアーカイブの作成または操作中にエラーが発生しました。\n";
102        echo "PHPの設定 'phar.readonly = 0' がphp.iniで有効になっていることを確認してください。\n";
103        echo "多くのサーバーではセキュリティのため 'phar.readonly = 1' に設定されています。ローカル環境でテストしてください。\n";
104    } catch (Exception $e) {
105        echo "予期せぬエラー: " . $e->getMessage() . "\n";
106    } finally {
107        // ----------------------------------------------------
108        // クリーンアップフェーズ
109        // ----------------------------------------------------
110        // Pharオブジェクトがまだ開いている場合は、明示的に解放
111        if ($phar instanceof PharData) {
112            unset($phar);
113        }
114        // 作成されたPharアーカイブファイルを削除します。
115        if (file_exists($pharPath)) {
116            unlink($pharPath);
117            echo "\nPharアーカイブ '{$pharPath}' を削除しました。\n";
118        }
119        if (file_exists($pharPath . '.gz')) { // 念のため、全体圧縮されたPharファイルも削除
120            unlink($pharPath . '.gz');
121            echo "Pharアーカイブ '{$pharPath}.gz' を削除しました。\n";
122        }
123    }
124}
125
126// 関数の実行
127demonstratePharIsCompressed();

PharFileInfo::isCompressed()は、PHPのPhar拡張機能において、Pharアーカイブ内に含まれる個々のファイルが圧縮されているかどうかを判定するメソッドです。このメソッドは引数を一切取らず、ファイルが圧縮されていれば true、圧縮されていなければ false のブール値を戻り値として返します。

サンプルコードでは、PHP 8環境でPharアーカイブを一時的に作成し、意図的に圧縮されたファイルと非圧縮のファイルをそれぞれアーカイブに追加しています。その後、作成したPharアーカイブを開き、PharFileInfo オブジェクトを通じて各ファイルの isCompressed() メソッドを呼び出すことで、それぞれの圧縮状態を確認する様子が示されています。

PHPではバージョンアップに伴い一部の機能が非推奨（deprecated）となることがありますが、PharFileInfo::isCompressed() はPHP 8においても引き続き推奨される機能であり、安心して利用できます。ただし、Pharアーカイブを作成する際には php.ini で phar.readonly = 0 の設定が必要になる点にはご注意ください。

Copy
1<?php
2
3/**
4 * PharFileInfo::isCompressed() メソッドの動作をデモンストレーションします。
5 *
6 * この関数は、一時的なPharアーカイブ（PHPアーカイブ）ファイルを作成し、
7 * その中のファイルが圧縮されているかどうかを確認します。
8 *
9 * 【重要】このスクリプトを実行するには、PHPの 'phar.readonly' 設定が '0' である必要があります。
10 *        通常は 'php.ini' ファイルで設定しますが、コマンドラインで一時的に設定することも可能です。
11 *        例: php -d phar.readonly=0 your_script_name.php
12 *
13 * キーワード "php' is not recognized as an internal or external command" について:
14 * これは、PHPがシステムに正しくインストールされていないか、
15 * 環境変数PATHが設定されていない場合に発生するエラーです。
16 * このサンプルコードはPHPが正常に動作する環境を前提としており、
17 * 上記エラーはPHPの実行環境設定に関するものです。
18 * スクリプトの実行自体には、PHPインタープリタが利用可能である必要があります。
19 */
20function demonstratePharFileCompression(): void
21{
22    // Pharファイルをプログラムで作成・変更するには、'phar.readonly' を '0' に設定する必要があります。
23    // 設定が '1' (読み取り専用) の場合はエラーメッセージを表示して終了します。
24    if (ini_get('phar.readonly') === '1') {
25        echo "エラー: Pharファイルを書き込むには、php.iniで 'phar.readonly = 0' に設定するか、\n";
26        echo "       PHPの実行時に '-d phar.readonly=0' オプションを使用してください。\n";
27        return;
28    }
29
30    $basePath = __DIR__ . '/temp_test'; // 一時ファイルのベースパス
31
32    // --- 1. 圧縮されていないPharファイルを作成し、isCompressed()の結果を確認 ---
33    $uncompressedPharPath = $basePath . '_uncompressed.phar';
34    // 以前に作成されたファイルがあれば削除
35    if (file_exists($uncompressedPharPath)) {
36        unlink($uncompressedPharPath);
37    }
38
39    try {
40        echo "--- 圧縮されていないPharファイルの作成と確認 ---\n";
41        // 新しいPharアーカイブを作成
42        $phar = new Phar($uncompressedPharPath);
43        $phar->startBuffering(); // 書き込み操作のバッファリングを開始
44        $phar->addFromString('file_a.txt', 'これは圧縮されていないファイルAのコンテンツです。');
45        $phar->addFromString('file_b.txt', 'これは圧縮されていないファイルBのコンテンツです。');
46        // compressFiles() を呼び出さないため、追加されたファイルは未圧縮のままになります。
47        $phar->stopBuffering(); // 書き込み操作のバッファリングを終了し、ファイルを保存
48        echo "Pharファイル '{$uncompressedPharPath}' を作成しました。\n";
49
50        // 作成したPharファイルを開き、各ファイルの圧縮状態をチェック
51        $archive = new Phar($uncompressedPharPath);
52        foreach ($archive as $fileName => $file) {
53            /** @var PharFileInfo $file */ // 型ヒントによりIDEの補完が効きます
54            echo "ファイル名: " . $fileName . " -> 圧縮されているか: " . ($file->isCompressed() ? 'はい' : 'いいえ') . "\n";
55        }
56        $archive = null; // Pharオブジェクトを解放し、ファイルハンドルを閉じます
57
58    } catch (Exception $e) {
59        echo "エラー: 圧縮されていないPharファイルの作成中に問題が発生しました: " . $e->getMessage() . "\n";
60    } finally {
61        // クリーンアップ: 一時的に作成したPharファイルを削除
62        if (file_exists($uncompressedPharPath)) {
63            unlink($uncompressedPharPath);
64            echo "一時ファイル '{$uncompressedPharPath}' を削除しました。\n\n";
65        }
66    }
67
68    // --- 2. GZ圧縮されたPharファイルを作成し、isCompressed()の結果を確認 ---
69    $compressedPharPath = $basePath . '_compressed.phar';
70    // 以前に作成されたファイルがあれば削除
71    if (file_exists($compressedPharPath)) {
72        unlink($compressedPharPath);
73    }
74
75    try {
76        echo "--- GZ圧縮されたPharファイルの作成と確認 ---\n";
77        // 新しいPharアーカイブを作成
78        $phar = new Phar($compressedPharPath);
79        $phar->startBuffering();
80        $phar->addFromString('file_x.txt', 'これはGZ圧縮されるファイルXのコンテンツです。');
81        $phar->addFromString('file_y.txt', 'これはGZ圧縮されるファイルYのコンテンツです。');
82        // Phar::GZ を指定して、アーカイブ内のすべてのファイルをGZ形式で圧縮します
83        $phar->compressFiles(Phar::GZ);
84        $phar->stopBuffering();
85        echo "Pharファイル '{$compressedPharPath}' を作成しました。\n";
86
87        // 作成したPharファイルを開き、各ファイルの圧縮状態をチェック
88        $archive = new Phar($compressedPharPath);
89        foreach ($archive as $fileName => $file) {
90            /** @var PharFileInfo $file */
91            echo "ファイル名: " . $fileName . " -> 圧縮されているか: " . ($file->isCompressed() ? 'はい' : 'いいえ') . "\n";
92        }
93        $archive = null; // Pharオブジェクトを解放
94
95    } catch (Exception $e) {
96        echo "エラー: GZ圧縮されたPharファイルの作成中に問題が発生しました: " . $e->getMessage() . "\n";
97    } finally {
98        // クリーンアップ: 一時的に作成したPharファイルを削除
99        if (file_exists($compressedPharPath)) {
100            unlink($compressedPharPath);
101            echo "一時ファイル '{$compressedPharPath}' を削除しました。\n";
102        }
103    }
104}
105
106// デモンストレーション関数を実行
107demonstratePharFileCompression();

PHP 8のPharFileInfo::isCompressed()メソッドは、PHPアーカイブ（Pharファイル）内に格納されている個々のファイルがデータ圧縮されているかを判断します。このメソッドは引数を持たず、戻り値として真偽値（trueまたはfalse）を返します。ファイルが圧縮されていればtrue、されていなければfalseを返します。

サンプルコードでは、まず圧縮されていないPharファイルを作成し、次にGZ形式で圧縮されたPharファイルを作成します。それぞれのPharファイル内の各エントリについてisCompressed()メソッドを呼び出し、その結果を表示しています。圧縮されていないPhar内のファイルではisCompressed()はfalseを返し、GZ圧縮されたPhar内のファイルではtrueを返すことを確認できます。これにより、Pharアーカイブ内の個々のファイルが圧縮されているかどうかをプログラム的に判別できることが示されます。

Pharファイルを書き込む際には、PHPの設定ファイル（php.ini）でphar.readonly = 0と設定するか、コマンドラインで-d phar.readonly=0オプションを指定する必要があります。これが設定されていない場合、Pharファイルの作成や変更ができません。

なお、サンプルコード冒頭に記載されている「php' is not recognized as an internal or external command」というエラーは、PHPがシステムに正しくインストールされていないか、環境変数PATHが設定されていない場合に発生するもので、本メソッドの機能そのものとは関係なく、PHP実行環境の準備に関する問題です。