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

Copy
1<?php
2
3/**
4 * Phar::getPathInfo() メソッドのサンプルコード
5 *
6 * システムエンジニアを目指す初心者向けに、Pharアーカイブ内の特定エントリの
7 * パス情報を取得する方法を示します。
8 */
9
10// --- 準備フェーズ ---
11$pharFileName = 'my_example.phar'; // 作成するPharアーカイブのファイル名
12$internalFileName = 'sample_file.txt'; // アーカイブ内に含めるファイル名
13$tempContentDir = 'temp_phar_content'; // アーカイブ化するファイルの一時的な格納ディレクトリ
14
15// 一時ディレクトリと内部ファイルを準備
16if (!is_dir($tempContentDir)) {
17    mkdir($tempContentDir);
18}
19file_put_contents($tempContentDir . '/' . $internalFileName, "これはPharアーカイブ内のサンプルファイルです。");
20
21// 既存のPharアーカイブがあれば削除し、クリーンな状態にする
22if (file_exists($pharFileName)) {
23    unlink($pharFileName);
24}
25
26// --- 実行フェーズ ---
27try {
28    // Pharアーカイブを作成するために、phar.readonly 設定を一時的に無効にする
29    // 通常、Pharアーカイブの作成や変更にはこの設定を Off にする必要があります。
30    $oldPharReadonly = ini_get('phar.readonly');
31    ini_set('phar.readonly', '0');
32
33    // 1. 新しいPharアーカイブを作成
34    $phar = new Phar($pharFileName);
35    $phar->buildFromDirectory($tempContentDir); // ディレクトリの内容をアーカイブに追加
36    $phar->setDefaultStub(); // Pharを直接実行可能にするためのスタブを設定
37
38    echo "Pharアーカイブ '{$pharFileName}' が正常に作成されました。\n";
39
40    // 2. Phar::getPathInfo() メソッドの使用
41    // このメソッドは、Pharアーカイブ内の指定されたエントリ（ファイルまたはディレクトリ）に対応する
42    // SplFileInfo オブジェクトを返します。
43    // ※注意: PHPのPhar::getPathInfo()メソッドは、引数としてアーカイブ内のエントリ名を必要とします。
44    //         戻り値のSplFileInfoオブジェクトは、ファイルパスに関する詳細情報を提供します。
45    //         これは、キーワードにある pathinfo() 関数が提供する情報と類似しています。
46
47    if (isset($phar[$internalFileName])) {
48        // 指定したエントリのSplFileInfoオブジェクトを取得
49        $splFileInfo = $phar->getPathInfo($internalFileName);
50
51        echo "\nPharアーカイブ内の '{$internalFileName}' の情報:\n";
52        echo "  - 完全なパス名 (getPathname()): " . $splFileInfo->getPathname() . "\n"; // アーカイブ内のファイルパス
53        echo "  - ファイル名 (getFilename()): " . $splFileInfo->getFilename() . "\n";     // ファイル名と拡張子
54        echo "  - 拡張子 (getExtension()): " . $splFileInfo->getExtension() . "\n";     // ファイルの拡張子
55        echo "  - 親ディレクトリのパス (getPath()): " . $splFileInfo->getPath() . "\n";     // 親ディレクトリのパス
56        echo "  - ファイルタイプ (getType()): " . $splFileInfo->getType() . "\n";       // 'file' または 'dir'
57    } else {
58        echo "エラー: 指定されたエントリ '{$internalFileName}' はPharアーカイブ内に見つかりませんでした。\n";
59    }
60
61} catch (Exception $e) {
62    echo "エラーが発生しました: " . $e->getMessage() . "\n";
63} finally {
64    // --- クリーンアップフェーズ ---
65    // phar.readonly 設定を元の値に戻す
66    ini_set('phar.readonly', $oldPharReadonly);
67
68    // 作成したPharアーカイブファイルと一時ディレクトリを削除
69    if (file_exists($pharFileName)) {
70        unlink($pharFileName);
71    }
72    if (file_exists($tempContentDir . '/' . $internalFileName)) {
73        unlink($tempContentDir . '/' . $internalFileName);
74    }
75    if (is_dir($tempContentDir)) {
76        rmdir($tempContentDir);
77    }
78    echo "\nサンプルコードの実行が完了し、一時ファイルがクリーンアップされました。\n";
79}
80

PHPのPhar::getPathInfo()メソッドは、複数のファイルを一つにまとめるPharアーカイブ内の特定のエントリ（ファイルやディレクトリ）について、詳細なパス情報を取得するために使用されます。このメソッドは、情報取得の対象となるアーカイブ内のエントリ名を引数として受け取ります。

戻り値はSplFileInfoオブジェクトで、このオブジェクトを通じて、エントリの完全なパス名、ファイル名、拡張子、親ディレクトリのパス、ファイルタイプ（ファイルかディレクトリか）など、様々なファイル関連情報を取得できます。これはPHPの標準関数pathinfo()がファイルパスから情報を得るのと似ていますが、Phar::getPathInfo()はPharアーカイブ内部のエントリに特化している点が特徴です。

サンプルコードでは、my_example.pharというアーカイブを作成し、その中にsample_file.txtというファイルを含めます。その後、$phar->getPathInfo('sample_file.txt')を呼び出すことで、sample_file.txtに関するSplFileInfoオブジェクトを取得し、そこからパス名、ファイル名、拡張子といった具体的な情報を取得・表示しています。これにより、Pharアーカイブの内部構造をプログラムから詳細に確認できるようになります。

Copy
1<?php
2
3/**
4 * Phar::getPathInfo() メソッドの利用例をデモンストレーションします。
5 * このメソッドは、Pharアーカイブファイル自体の情報を SplFileInfo オブジェクトとして返します。
6 * システムエンジニアを目指す初心者向けに、Pharアーカイブの作成から情報の取得、クリーンアップまでを示します。
7 */
8function demonstratePharGetPathInfo(): void
9{
10    // 一時的なPharファイルの名前と、Pharに含めるソースディレクトリのパスを定義します
11    $pharPath = __DIR__ . '/my_application.phar';
12    $sourceDir = __DIR__ . '/phar_source_content';
13
14    // --- ステップ1: 環境の準備とPharコンテンツの作成 ---
15    // Pharアーカイブを作成するためには、php.iniの 'phar.readonly' を '0' に設定する必要があります。
16    // スクリプトの実行中に一時的に設定を変更し、終了時に元に戻します。
17    $originalPharReadonly = ini_get('phar.readonly');
18    if ($originalPharReadonly == 1) {
19        ini_set('phar.readonly', 0);
20    }
21
22    // Pharに含めるダミーファイルを作成するためのディレクトリとファイルを作成します。
23    if (!is_dir($sourceDir)) {
24        mkdir($sourceDir);
25    }
26    file_put_contents($sourceDir . '/index.php', '<?php echo "Hello from Phar!";');
27    file_put_contents($sourceDir . '/config.txt', 'This is a config file.');
28
29    try {
30        // --- ステップ2: Pharアーカイブの作成 ---
31        // 既にPharファイルが存在する場合は削除し、クリーンな状態で開始します。
32        if (file_exists($pharPath)) {
33            unlink($pharPath);
34        }
35
36        // 新しいPharアーカイブを作成します。
37        $phar = new Phar($pharPath);
38
39        // バッファリングを開始し、Pharの内容を変更できるようにします。
40        $phar->startBuffering();
41
42        // ソースディレクトリからファイルを追加してPharアーカイブを構築します。
43        $phar->buildFromDirectory($sourceDir);
44
45        // Pharの実行時に起動するスタブを設定します。ここではデフォルトのスタブを使用します。
46        $phar->setStub($phar->createDefaultStub('index.php'));
47
48        // バッファリングを停止し、Pharアーカイブをディスクに書き込みます。
49        $phar->stopBuffering();
50
51        echo "Pharアーカイブが作成されました: " . realpath($pharPath) . "\n";
52
53        // --- ステップ3: Phar::getPathInfo() の使用 ---
54        // 作成されたPharアーカイブを読み込み専用モードで開きます。
55        // これにより、Phar::getPathInfo() を呼び出す準備が整います。
56        $readPhar = new Phar($pharPath);
57
58        // Pharアーカイブファイル自体の SplFileInfo オブジェクトを取得します。
59        // このオブジェクトは、'my_application.phar' ファイルに関する情報を提供します。
60        $pharFileInfo = $readPhar->getPathInfo();
61
62        // --- ステップ4: SplFileInfo オブジェクトからの情報取得 ---
63        echo "\nPharアーカイブファイル自体の情報:\n";
64        // ファイル名を取得します (例: my_application.phar)
65        echo "ファイル名 (getFilename): " . $pharFileInfo->getFilename() . "\n";
66        // ファイルの絶対パス名を取得します (例: /path/to/my_application.phar)
67        echo "パス名 (getPathname): " . $pharFileInfo->getPathname() . "\n";
68        // ファイルの拡張子を取得します (例: phar)
69        echo "拡張子 (getExtension): " . $pharFileInfo->getExtension() . "\n";
70        // ファイルサイズをバイト単位で取得します (例: 2048)
71        echo "サイズ (getSize): " . $pharFileInfo->getSize() . " バイト\n";
72
73    } catch (PharException $e) {
74        // Phar関連のエラーが発生した場合の処理
75        echo "Pharの作成またはアクセス中にエラーが発生しました: " . $e->getMessage() . "\n";
76    } finally {
77        // --- ステップ5: 一時ファイルのクリーンアップと設定の復元 ---
78        echo "\nクリーンアップを実行中...\n";
79
80        // 一時的なソースディレクトリとその内容を削除します。
81        if (is_dir($sourceDir)) {
82            $files = array_diff(scandir($sourceDir), ['.', '..']);
83            foreach ($files as $file) {
84                unlink($sourceDir . '/' . $file);
85            }
86            rmdir($sourceDir);
87        }
88
89        // 作成したPharアーカイブファイルを削除します。
90        if (file_exists($pharPath)) {
91            unlink($pharPath);
92        }
93
94        // 'phar.readonly' の設定を元の状態に戻します。
95        if ($originalPharReadonly == 1) {
96            ini_set('phar.readonly', $originalPharReadonly);
97        }
98        echo "クリーンアップが完了しました。\n";
99    }
100}
101
102// デモンストレーション関数を実行します。
103demonstratePharGetPathInfo();

PHPのPhar::getPathInfo()メソッドは、Pharクラスに属し、Pharアーカイブファイル自体に関する詳細な情報を取得するために使用されます。このメソッドは引数を一切必要とせず、呼び出すだけで対象のPharアーカイブファイルを表すSplFileInfoオブジェクトを返します。

SplFileInfoオブジェクトは、ファイル名、ファイルが格納されているディレクトリのパス、ファイルの絶対パス名（getPathname()メソッドで取得可能）、ファイルサイズ、拡張子、最終更新時刻など、ファイルシステム上のファイルに関する多様なプロパティを提供します。

サンプルコードでは、まず一時的なPharアーカイブファイルを作成する準備と処理を行い、その後、作成されたPharオブジェクトに対してgetPathInfo()メソッドを呼び出しています。これにより、my_application.pharというファイルそのものの情報を持つSplFileInfoオブジェクトが取得されます。そして、そのSplFileInfoオブジェクトからgetFilename()でファイル名、getPathname()で絶対パス名、getExtension()で拡張子、getSize()でファイルサイズといった具体的な情報を取得し、出力しています。このように、Phar::getPathInfo()はPharアーカイブファイル自身のメタデータにプログラムからアクセスする簡潔な方法を提供し、システム運用などでPharファイルの情報を動的に確認する際に役立ちます。