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

Copy
1<?php
2
3// この関数は、PHPのPhar拡張機能を使用してアーカイブファイルを作成し、
4// その中にある特定のファイルの情報（メタデータ）を取得する方法を示します。
5// システムエンジニアを目指す初心者の方でも理解しやすいように、基本的な流れを追って説明します。
6function demonstratePharGetFileInfo(): void
7{
8    // 1. サンプルで使用するPharアーカイブと内部ファイルのファイル名を定義します。
9    $pharFileName = 'my_sample_archive.phar';
10    $entryFileName = 'hello_world.txt'; // アーカイブ内に格納するファイル名
11
12    // Pharアーカイブを作成するために、php.ini設定の 'phar.readonly' を一時的に変更する場合があります。
13    // 通常、'phar.readonly' はセキュリティ上の理由から '1' (読み取り専用) に設定されています。
14    // 作成や書き込みを行う場合は '0' に設定する必要があります。
15    // 関数終了時には元の設定に戻すようにします。
16    $oldPharReadonly = ini_get('phar.readonly');
17    $needsIniSetRestore = false; // ini_setが実際に呼び出されたかを追跡するフラグ
18
19    if ($oldPharReadonly === '1') {
20        ini_set('phar.readonly', '0');
21        $needsIniSetRestore = true;
22        echo "phar.readonly を一時的に '0' に設定しました。\n";
23    }
24
25    try {
26        // 2. 新しいPharアーカイブを作成し、ファイルを追加します。
27        echo "Pharアーカイブ '{$pharFileName}' を作成中です...\n";
28        // Pharコンストラクタにファイル名を渡すと、新しいアーカイブが作成されるか、
29        // 既存のアーカイブが開かれます。
30        $phar = new Phar($pharFileName);
31
32        // addFromString() メソッドを使って、文字列コンテンツをファイルとしてアーカイブに追加します。
33        $phar->addFromString($entryFileName, "This is a test file inside the Phar archive.\n");
34        echo "ファイル '{$entryFileName}' をアーカイブに追加しました。\n";
35        echo "Pharアーカイブの作成が完了しました。\n\n";
36
37        // 3. 作成したPharアーカイブからファイル情報を取得します。
38        echo "Pharアーカイブ '{$pharFileName}' からファイル情報を取得中です...\n";
39        // getFileInfo() メソッドは、指定されたアーカイブ内のエントリ名に対応する
40        // PharFileInfoオブジェクトを返します。このオブジェクトには、ファイル名、サイズ、
41        // 最終更新日時などのメタデータが含まれています。
42        $pharFileInfo = $phar->getFileInfo($entryFileName);
43
44        if ($pharFileInfo) {
45            echo "--- アーカイブ内のファイル情報 ('{$entryFileName}') ---\n";
46            echo "  ファイル名: " . $pharFileInfo->getFilename() . "\n";
47            echo "  サイズ: " . $pharFileInfo->getSize() . " バイト\n";
48            echo "  最終更新日時: " . date('Y-m-d H:i:s', $pharFileInfo->getMTime()) . "\n";
49            echo "  ディレクトリか？: " . ($pharFileInfo->isDir() ? 'はい' : 'いいえ') . "\n";
50            echo "  ファイルか？: " . ($pharFileInfo->isFile() ? 'はい' : 'いいえ') . "\n";
51            // 他にもパーミッションなど、様々な情報がPharFileInfoオブジェクトから取得できます。
52        } else {
53            echo "エラー: ファイル '{$entryFileName}' はアーカイブ内に見つかりませんでした。\n";
54        }
55
56    } catch (PharException $e) {
57        // Phar関連の操作中に発生した例外を捕捉し、エラーメッセージを表示します。
58        echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
59    } finally {
60        // 4. クリーンアップ: phar.readonly の設定を元に戻し、作成したPharファイルを削除します。
61        // ini_set() で変更した設定を元の状態に戻します。
62        if ($needsIniSetRestore) {
63            ini_set('phar.readonly', $oldPharReadonly);
64            echo "\nphar.readonly を元の状態 ('1') に戻しました。\n";
65        }
66
67        // 作成したPharアーカイブファイルが存在すれば削除します。
68        if (file_exists($pharFileName)) {
69            echo "Pharアーカイブ '{$pharFileName}' を削除中です...\n";
70            // Phar::unlinkArchive() 静的メソッドを使用してPharファイルを安全に削除します。
71            Phar::unlinkArchive($pharFileName);
72            echo "Pharアーカイブが削除されました。\n";
73        }
74    }
75}
76
77// サンプル関数を実行します。
78demonstratePharGetFileInfo();
79
80?>

PHPのPhar拡張機能は、複数のPHPファイルや関連ファイルを一つのアーカイブファイル（.phar形式）にまとめ、配布や実行を容易にするための機能です。このサンプルコードは、Pharアーカイブを作成し、その中に格納された特定のファイルの情報を取得する一連の流れをシステムエンジニアを目指す初心者の方にも分かりやすく示しています。

Phar::getFileInfoメソッドは、作成済みまたは開かれたPharアーカイブ内で、指定されたファイル名（string $entry）に対応する詳細なファイル情報を取得するために使用されます。このメソッドは、取得した情報をPharFileInfoオブジェクトとして返します。PharFileInfoオブジェクトには、アーカイブ内のファイル名、サイズ、最終更新日時、パーミッション、ディレクトリかファイルかといった、様々なメタデータが格納されています。

サンプルコードでは、まずPharアーカイブを作成するために、一時的にPHPの設定であるphar.readonlyを変更しています。次に、my_sample_archive.pharという名前の新しいアーカイブを作成し、addFromStringメソッドを使ってhello_world.txtという仮想的なファイルをアーカイブ内に追加しています。その後、getFileInfoメソッドにhello_world.txtというエントリ名を指定して呼び出し、そのファイルに関するPharFileInfoオブジェクトを取得します。取得したオブジェクトが持つgetFilename()、getSize()、getMTime()などのメソッドを通じて、ファイルの具体的な情報を画面に表示しています。最後に、一時的に変更した設定を元に戻し、作成したアーカイブファイルを削除してクリーンアップを行っています。このように、getFileInfoはアーカイブ内のファイルをプログラムで管理する上で非常に便利な機能です。