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

Copy
1<?php
2
3// このサンプルコードは、Phar拡張機能のPharFileInfo::getType()メソッドの使用方法を示します。
4// このメソッドは、Pharアーカイブ内のエントリ（ファイルまたはディレクトリ）の種類を整数値で返します。
5
6// Phar拡張機能が読み込まれているか確認
7if (!extension_loaded('phar')) {
8    die('エラー: Phar拡張機能が読み込まれていません。php.iniで有効にしてください。');
9}
10
11// Pharアーカイブを作成するためには、php.iniで "phar.readonly = 0" が設定されている必要があります。
12if (ini_get('phar.readonly') == 1) {
13    die("エラー: php.iniで phar.readonly が '1' に設定されています。Pharアーカイブを作成するには '0' に設定してください。");
14}
15
16/**
17 * PharFileInfo::getType()が返す整数値を、人間が読める文字列に変換します。
18 *
19 * @param int $type getType()メソッドから返されたファイルの種類を示す整数値
20 * @return string ファイルの種類を表す文字列
21 */
22function getPharFileTypeString(int $type): string
23{
24    switch ($type) {
25        case Phar::FT_UNKNOWN: return '不明なタイプ';
26        case Phar::FT_DIR: return 'ディレクトリ';
27        case Phar::FT_FILE: return 'ファイル';
28        case Phar::FT_PHAR: return 'ネストされたPharアーカイブ'; // ほとんどの場合、Phar内部にPharがある場合
29        case Phar::FT_LINK: return 'シンボリックリンク';
30        default: return '未定義 (' . $type . ')';
31    }
32}
33
34// 一時的なPharアーカイブのパスと、アーカイブに含めるファイルを作成する一時ディレクトリのパスを定義
35$pharPath = __DIR__ . '/my_sample_archive.phar';
36$tempContentDir = __DIR__ . '/temp_phar_contents';
37
38// --- クリーンアップと一時ファイルの準備 ---
39echo "--- サンプル環境準備中 ---\n";
40
41// 以前の実行で残ったPharファイルを削除
42if (file_exists($pharPath)) {
43    unlink($pharPath);
44}
45// 以前の実行で残った一時ディレクトリとその内容を削除
46if (is_dir($tempContentDir)) {
47    $it = new RecursiveDirectoryIterator($tempContentDir, RecursiveDirectoryIterator::SKIP_DOTS);
48    $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
49    foreach ($files as $file) {
50        if ($file->isDir()) {
51            rmdir($file->getRealPath());
52        } else {
53            unlink($file->getRealPath());
54        }
55    }
56    rmdir($tempContentDir);
57}
58
59// アーカイブに含める一時ディレクトリとファイルを作成
60mkdir($tempContentDir);
61file_put_contents($tempContentDir . '/document.txt', 'これはテキストファイルです。');
62mkdir($tempContentDir . '/src');
63file_put_contents($tempContentDir . '/src/script.php', '<?php echo "Hello from Phar!";');
64file_put_contents($tempContentDir . '/config.ini', '[settings]\nkey=value');
65
66echo "一時ファイルとディレクトリを作成しました: {$tempContentDir}\n";
67
68// --- Pharアーカイブの作成とgetType()のデモンストレーション ---
69try {
70    // 新しいPharアーカイブを作成
71    $phar = new Phar($pharPath, 0, 'my_sample_archive.phar');
72    $phar->startBuffering(); // 変更のバッファリングを開始
73    $phar->buildFromDirectory($tempContentDir); // ディレクトリの内容をアーカイブに追加
74    $phar->stopBuffering(); // 変更をディスクに書き込み
75
76    echo "Pharアーカイブ '{$pharPath}' が正常に作成されました。\n\n";
77
78    echo "--- PharFileInfo::getType() でアーカイブ内容を分析中 ---\n";
79
80    // アーカイブ内の各エントリをループし、getType()で種類を判別
81    foreach ($phar as $entry) {
82        /** @var PharFileInfo $entry */
83        $fileName = $entry->getFilename(); // エントリ名を取得
84        $fileTypeInt = $entry->getType();  // getType()メソッドを呼び出し、種類を整数値で取得
85        $fileTypeString = getPharFileTypeString($fileTypeInt); // 整数値を文字列に変換
86
87        echo sprintf(
88            "エントリ: %-30s | タイプ値: %-2d | 解釈: %s\n",
89            $fileName,
90            $fileTypeInt,
91            $fileTypeString
92        );
93    }
94
95} catch (PharException $e) {
96    echo "Phar関連エラー: " . $e->getMessage() . "\n";
97} finally {
98    // --- クリーンアップ ---
99    // Pharオブジェクトのハンドルを解放し、ファイル削除を可能にする
100    $phar = null;
101
102    // 作成したPharアーカイブを削除
103    if (file_exists($pharPath)) {
104        unlink($pharPath);
105        echo "\nPharアーカイブ '{$pharPath}' を削除しました。\n";
106    }
107
108    // 一時ディレクトリとその内容を削除
109    if (is_dir($tempContentDir)) {
110        $it = new RecursiveDirectoryIterator($tempContentDir, RecursiveDirectoryIterator::SKIP_DOTS);
111        $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
112        foreach ($files as $file) {
113            if ($file->isDir()) {
114                rmdir($file->getRealPath());
115            } else {
116                unlink($file->getRealPath());
117            }
118        }
119        rmdir($tempContentDir);
120        echo "一時ディレクトリ '{$tempContentDir}' を削除しました。\n";
121    }
122}

PHPのPharFileInfo::getType()メソッドは、Pharアーカイブ内の個々のエントリ（ファイルやディレクトリなど）の種類を識別します。このメソッドは引数を取らず、戻り値としてエントリの種類を示す整数値を返します。ファイルならPhar::FT_FILE、ディレクトリならPhar::FT_DIRといったPharクラスの定数で、その種類を判別できます。

サンプルコードでは、Phar拡張機能の有効性やPharアーカイブ作成の許可（php.iniのphar.readonly設定）を確認後、一時的なPharアーカイブを作成し、ファイルやディレクトリを追加しています。作成されたアーカイブ内の各エントリに対し、PharFileInfoオブジェクト経由でgetType()を呼び出します。これにより、エントリの種類（ファイル、ディレクトリなど）をプログラム的に取得し、それに応じた処理の分岐や、人間が読める形式での表示が可能になります。この機能は、Pharアーカイブの内容を検査・管理する際に非常に役立ちます。

Copy
1<?php
2
3/**
4 * テスト用のPharアーカイブを作成し、内部にファイルとディレクトリを追加します。
5 *
6 * @param string $pharPath 作成するPharアーカイブファイルのパス
7 */
8function createTestPharArchive(string $pharPath): void
9{
10    // 既存のPharアーカイブを削除します。これはテストを繰り返す際にクリーンな状態を保つためです。
11    if (file_exists($pharPath)) {
12        unlink($pharPath);
13    }
14
15    try {
16        // Pharクラスのインスタンスを作成します。
17        // 第一引数: 作成するPharアーカイブのファイルパス
18        // 第二引数: フラグ（0はデフォルト、SPLのPharFlags::NONEに相当）
19        // 第三引数: アーカイブのエイリアス（Phar::webPhar()などで使用）
20        $phar = new Phar($pharPath, 0, 'test.phar');
21
22        // アーカイブの変更をバッファリング開始します。
23        // これにより、複数のファイルを追加しても一度にディスクに書き込まれます。
24        $phar->startBuffering();
25
26        // アーカイブ内に通常のファイルを追加します。
27        // addFromString(内部パス, ファイル内容)
28        $phar->addFromString('file_in_phar.txt', 'これはPharアーカイブ内のテキストファイルです。');
29        $phar->addFromString('another_file.php', '<?php echo "Pharアーカイブからこんにちは！";');
30
31        // アーカイブ内に空のディレクトリを追加します。
32        $phar->addEmptyDir('data_dir');
33        // 作成したディレクトリ内にファイルを追加します。
34        $phar->addFromString('data_dir/config.json', '{"setting": "value", "enabled": true}');
35
36        // Pharアーカイブのスタブを設定します。
37        // スタブは、Pharアーカイブが直接PHPインタプリタで実行されたときに実行されるコードです。
38        // createDefaultStub()は基本的なスタブを生成します。
39        $phar->setStub($phar->createDefaultStub('index.php'));
40
41        // バッファリングを終了し、変更をPharアーカイブに書き込みます。
42        $phar->stopBuffering();
43
44        echo "Pharアーカイブ '{$pharPath}' が正常に作成されました。\n";
45    } catch (PharException $e) {
46        // Phar関連のエラーが発生した場合にキャッチします。
47        echo "Pharアーカイブの作成中にエラーが発生しました: " . $e->getMessage() . "\n";
48        exit(1); // スクリプトを終了します。
49    }
50}
51
52/**
53 * PharFileInfo::getType() が返す整数値を、人間が読める文字列に変換します。
54 *
55 * @param int $typeValue PharFileInfo::getType() の戻り値
56 * @return string ファイルタイプを示す文字列
57 */
58function getPharFileTypeString(int $typeValue): string
59{
60    // PHP 8以降で利用可能なmatch式を使用し、値を比較して対応する文字列を返します。
61    return match ($typeValue) {
62        Phar::PHAR_FILE_FILE => '通常のファイル',      // 通常のファイルを示します。
63        Phar::PHAR_FILE_DIR  => 'ディレクトリ',         // ディレクトリを示します。
64        // 必要に応じて、他のPharファイルタイプ定数も追加できます（例: Phar::PHAR_FILE_LINK）。
65        default              => '不明なタイプ (' . $typeValue . ')', // 定義されていない値の場合
66    };
67}
68
69/**
70 * 指定されたPharFileInfoオブジェクトからファイルタイプを取得し、その情報を表示します。
71 *
72 * @param PharFileInfo $fileInfo ファイルの情報を保持するPharFileInfoオブジェクト
73 */
74function processPharFile(PharFileInfo $fileInfo): void
75{
76    // PharFileInfo::getType() メソッドを呼び出し、ファイルタイプを整数値で取得します。
77    // このメソッドは引数を取りません。
78    // 戻り値はPhar::PHAR_FILE_FILE や Phar::PHAR_FILE_DIR などの定数に対応する整数です。
79    $fileTypeInt = $fileInfo->getType();
80
81    // PHPのグローバル関数 gettype() を使用して、変数 $fileTypeInt の「型」を文字列で確認します。
82    // PharFileInfo::getType() はintを返しますが、gettype() はその変数が'integer'型であることを示します。
83    $returnedTypeString = gettype($fileTypeInt);
84
85    echo "  ファイル名: " . $fileInfo->getFilename() . "\n";
86    echo "  PharFileInfo::getType() の戻り値: {$fileTypeInt} (gettype()による型: '{$returnedTypeString}')\n";
87    // 取得した整数値を、より分かりやすい文字列に変換して表示します。
88    echo "  ファイルタイプ (可読形式): " . getPharFileTypeString($fileTypeInt) . "\n";
89    echo "----------------------------------------\n";
90}
91
92/**
93 * スクリプトのメイン実行ロジックです。
94 * テスト用のPharアーカイブを作成し、その中の各ファイルのタイプを検査します。
95 */
96function main(): void
97{
98    $pharFilePath = __DIR__ . '/test_archive.phar'; // 一時的なPharアーカイブのパス
99
100    // 1. テスト用のPharアーカイブを作成します。
101    createTestPharArchive($pharFilePath);
102
103    try {
104        // 2. 作成したPharアーカイブを読み込みモードで開きます。
105        // Pharオブジェクトは、アーカイブ内のファイルやディレクトリにアクセスするためのゲートウェイです。
106        $phar = new Phar($pharFilePath);
107
108        echo "\nPharアーカイブ '{$pharFilePath}' 内のファイルタイプを検査中:\n";
109        echo "========================================\n";
110
111        // 3. Pharアーカイブ内のすべてのエントリ（ファイルやディレクトリ）を反復処理します。
112        // RecursiveIteratorIteratorは、ディレクトリ構造を再帰的に走査するために使用されます。
113        // 各エントリはPharFileInfoオブジェクトとして取得されます。
114        foreach (new RecursiveIteratorIterator($phar) as $fileInfo) {
115            // 4. 各PharFileInfoオブジェクトに対して、ファイルタイプ処理関数を呼び出します。
116            processPharFile($fileInfo);
117        }
118
119    } catch (PharException $e) {
120        // Pharアーカイブの読み込み中にエラーが発生した場合にキャッチします。
121        echo "Pharアーカイブの読み込み中にエラーが発生しました: " . $e->getMessage() . "\n";
122    } finally {
123        // 5. 使用した一時的なPharアーカイブファイルをクリーンアップ（削除）します。
124        // これは、スクリプトの実行後に不要なファイルが残らないようにするための重要なステップです。
125        if (file_exists($pharFilePath)) {
126            unlink($pharFilePath);
127            echo "\nPharアーカイブ '{$pharFilePath}' を削除しました。\n";
128        }
129    }
130}
131
132// スクリプトのメイン関数を実行します。
133main();

PharFileInfo::getType() メソッドは、PHPのPhar（PHP Archive）拡張機能で使用され、Pharアーカイブ内に含まれるファイルやディレクトリの種別を判別するために利用されます。

このメソッドは引数を一切取らず、戻り値として整数型（int）の値を返します。返される整数値は、そのエントリが通常のファイルである場合はPhar::PHAR_FILE_FILE、ディレクトリである場合はPhar::PHAR_FILE_DIRといった、Pharクラスが定義する定数に対応しています。

サンプルコードでは、PharFileInfo::getType() が返す整数値が実際にどのようなPHPの型であるかを、グローバル関数であるgettype() を使って確認しています。gettype() は引数として渡された変数の型を文字列（例えば 'integer' や 'string' など）で返すため、このメソッドが期待通りint型を返していることがわかります。

また、サンプルコード内の getPharFileTypeString() 関数は、getType() が返す整数値を、「通常のファイル」や「ディレクトリ」といった、人間にとってより理解しやすい文字列に変換する例を示しています。これにより、Pharアーカイブ内の各エントリが何であるかをプログラム的に判断し、適切な処理を行うことが可能になります。このメソッドは、Pharアーカイブの内部構造を検査する際に非常に役立ちます。