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

Copy
1<?php
2
3/**
4 * Phar拡張のバージョンを確認し、出力します。
5 *
6 * この関数は、PHPのPhar拡張が利用可能である場合のそのバージョンを取得します。
7 * PHP自身のバージョンを確認する `phpversion()` 関数とは異なりますので注意してください。
8 *
9 * @return void
10 */
11function checkPharExtensionVersion(): void
12{
13    // Phar::getVersion() は、Phar拡張のバージョンを文字列として返します。
14    // 引数は不要で、Pharクラスの静的メソッドとして直接呼び出せます。
15    $pharVersion = Phar::getVersion();
16
17    echo "Phar 拡張のバージョン: " . $pharVersion . PHP_EOL;
18}
19
20// 関数を実行して、Phar拡張のバージョンを確認します。
21checkPharExtensionVersion();
22
23?>

このPHPサンプルコードは、PHPに組み込まれている「Phar」という拡張機能のバージョンを確認し、出力する方法を示しています。Pharは、複数のPHPファイルを一つのアーカイブ（まとまったファイル）として扱い、配布や実行を容易にするための機能です。このコードは、そのPhar機能が現在どのバージョンで動作しているかを知るために利用されます。

コード内で使用されているPhar::getVersion()は、Pharクラスに属する静的メソッドです。このメソッドは引数を一切必要とせず、呼び出すだけでPhar拡張のバージョン情報を文字列として返します。例えば、「2.0.2」といった形式のバージョン番号が戻り値として取得されます。

取得されたPharのバージョンは$pharVersionという変数に格納され、最終的にecho文によって「Phar 拡張のバージョン: [バージョン番号]」というメッセージとして画面に出力されます。

重要な注意点として、このPhar::getVersion()は、PHPシステム全体のバージョンを確認するphpversion()関数とは異なります。phpversion()がPHPエンジン自体のバージョンを示すのに対し、Phar::getVersion()はPHPに導入されているPharという特定の拡張機能のバージョンのみを示すものです。この違いを理解することで、より正確な環境情報を把握できます。

Copy
1<?php
2
3/**
4 * Phar::getVersion() メソッドの使用例と、PHPバージョンとの違いを示す関数です。
5 *
6 * この関数は、Pharアーカイブのバージョン情報を取得する方法を示します。
7 * 注意: Phar::getVersion() は、PHP言語自体のバージョンではなく、
8 *       Pharアーカイブファイルの内部バージョンを返します。
9 *       PHP言語のバージョンは phpversion() 関数で取得できます。
10 *
11 * システムエンジニアを目指す初心者の方へ:
12 * Pharは、複数のPHPファイルを1つのアーカイブファイルにまとめるための拡張機能です。
13 * これにより、アプリケーションの配布やデプロイが容易になります。
14 * このサンプルでは、一時的なPharファイルを作成して、そのバージョン情報を取得します。
15 * 実行には、PHP CLI (コマンドラインインターフェース) 環境と、
16 * ファイルシステムへの書き込み権限が必要です。
17 */
18function demonstratePharGetVersion(): void
19{
20    // 一時的なPharアーカイブファイルの名前を定義します。
21    $pharFileName = __DIR__ . '/my_temp_app.phar';
22
23    try {
24        // Pharアーカイブを作成します。
25        // Pharオブジェクトは、既存のファイルがあればそれを開き、なければ新しいアーカイブを作成しようとします。
26        // 注意: Webサーバー環境ではセキュリティ上の理由でPharファイルの作成・変更が制限されることがあります。
27        // このコードはCLI環境での実行を想定しています。
28        $phar = new Phar($pharFileName);
29
30        // Pharアーカイブへの書き込み操作を開始します。
31        $phar->startBuffering();
32
33        // アーカイブにシンプルなPHPファイルを追加します。
34        $phar->addFromString('index.php', '<?php echo "Hello from Phar!";');
35
36        // Pharアーカイブを実行可能にするためのデフォルトのスタブ (ブートストラップコード) を設定します。
37        $phar->setStub($phar->createDefaultStub('index.php'));
38
39        // 書き込み操作を終了し、アーカイブをファイルシステムに保存します。
40        $phar->stopBuffering();
41
42        echo "Pharアーカイブが正常に作成されました: " . $pharFileName . PHP_EOL;
43
44        // 作成したPharアーカイブのバージョンを取得します。
45        // ここで取得されるのは、Pharアーカイブのフォーマットバージョン（通常はPhar拡張機能のバージョンと関連）です。
46        $pharVersion = $phar->getVersion();
47        echo "Pharアーカイブのバージョン: " . $pharVersion . PHP_EOL;
48
49        // キーワード「php versionとは」への対応として、PHP言語自体のバージョンも示します。
50        echo "-------------------------------------" . PHP_EOL;
51        echo "参考情報:" . PHP_EOL;
52        echo "PHP言語自体のバージョン: " . phpversion() . PHP_EOL;
53        echo "Phar::getVersion() は上記のPHPバージョンとは異なります。" . PHP_EOL;
54        echo "-------------------------------------" . PHP_EOL;
55
56    } catch (PharException $e) {
57        // Phar関連のエラーが発生した場合の処理です。
58        echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
59        echo "Phar拡張機能が有効になっているか、およびファイルシステムへの書き込み権限があるか確認してください。" . PHP_EOL;
60        echo "php.iniで 'phar.readonly = Off' が設定されているかも確認してください。" . PHP_EOL;
61    } catch (Exception $e) {
62        // その他の予期せぬエラーが発生した場合の処理です。
63        echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
64    } finally {
65        // 処理終了後、作成した一時Pharアーカイブファイルを削除します。
66        // ファイルが存在するか確認してから削除することで、エラーを防ぎます。
67        if (file_exists($pharFileName)) {
68            // Phar::unlinkArchive() を使う場合は、Pharオブジェクトが閉じている必要がありますが、
69            // ファイルシステム関数 `unlink()` を直接使う方がシンプルで確実です。
70            unlink($pharFileName);
71            echo "一時Pharアーカイブファイルを削除しました: " . $pharFileName . PHP_EOL;
72        }
73    }
74}
75
76// 上記の関数を実行します。
77demonstratePharGetVersion();
78

Phar::getVersion() メソッドは、PHPで作成されたPharアーカイブファイルの内部バージョン情報を文字列として取得します。このメソッドは引数を必要とせず、Pharアーカイブのフォーマットバージョンを表す文字列を返します。Pharは、複数のPHPファイルを一つのアーカイブファイルにまとめることで、アプリケーションの配布やデプロイを容易にするための拡張機能です。

重要な点として、Phar::getVersion() が返すのはPharアーカイブ自体のバージョンであり、PHP言語のバージョンではありません。「php versionとは」という疑問に対し、PHP言語自体のバージョンは phpversion() 関数で取得できるため、これら二つが異なる情報であることを理解することが重要です。

提供されたサンプルコードでは、まず一時的なPharアーカイブファイルを作成し、その中にPHPファイルを追加しています。次に、作成したPharオブジェクトの getVersion() メソッドを呼び出し、アーカイブのバージョン情報を取得して表示します。この操作は主にCLI（コマンドラインインターフェース）環境での実行が想定されており、Pharファイルの作成にはファイルシステムへの書き込み権限や、PHPの設定 phar.readonly = Off が必要となる場合があります。最後に、処理を終えた一時ファイルを確実に削除するクリーンアップ処理も行われています。