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

Copy
1<?php
2
3/**
4 * テスト用のPharアーカイブを作成するヘルパー関数。
5 * この関数は、指定されたパスにPharアーカイブを作成し、
6 * その中にサンプルファイルとサンプルディレクトリを含めます。
7 *
8 * @param string $archivePath 作成するPharアーカイブのフルパス。
9 * @throws PharException Pharアーカイブの作成中にエラーが発生した場合。
10 */
11function createPharArchive(string $archivePath): void
12{
13    // php.iniのphar.readonly設定を一時的に無効にします。
14    // これはPharアーカイブを書き込むために必要です。
15    // 本番環境では、ビルドスクリプトなどで事前にアーカイブを作成し、
16    // この設定変更を避けることが推奨されます。
17    $oldReadonly = ini_get('phar.readonly');
18    ini_set('phar.readonly', '0');
19
20    try {
21        // 既に同じ名前のアーカイブが存在する場合は削除し、新しいものを作成します。
22        if (file_exists($archivePath)) {
23            unlink($archivePath);
24        }
25
26        // Pharオブジェクトを書き込みモードでインスタンス化します。
27        // これにより、指定されたパスにPharアーカイブが作成されます。
28        $phar = new Phar($archivePath);
29
30        // Pharアーカイブにファイルを追加します。
31        // 'example_file.txt' という名前で内容 'Hello, Phar!' を持つファイルを作成します。
32        $phar->addFromString('example_file.txt', 'Hello, Phar!');
33
34        // Pharアーカイブに空のディレクトリを追加します。
35        // 'example_dir' という名前のディレクトリを作成します。
36        $phar->addEmptyDir('example_dir');
37
38        // バッファリングを停止し、変更をPharアーカイブに書き込みます。
39        $phar->stopBuffering();
40
41        echo "テスト用Pharアーカイブ '{$archivePath}' を作成しました。\n";
42
43    } catch (PharException $e) {
44        // Phar操作中に例外が発生した場合、エラーメッセージを出力し、再スローします。
45        error_log("Pharアーカイブの作成中にエラー: " . $e->getMessage());
46        throw $e;
47    } finally {
48        // 元のphar.readonlyの設定に戻します。
49        ini_set('phar.readonly', $oldReadonly);
50    }
51}
52
53// --- メイン処理 ---
54// テスト用のPharアーカイブのパスを定義します。
55$pharFilePath = __DIR__ . '/test_archive.phar';
56
57try {
58    // 1. テスト用のPharアーカイブを作成します。
59    // このヘルパー関数が、ファイルとディレクトリを含むアーカイブを作成します。
60    createPharArchive($pharFilePath);
61
62    // 2. 作成したPharアーカイブを読み込みモードで開きます。
63    // PharクラスはPharアーカイブ全体を操作するためのメインクラスです。
64    $phar = new Phar($pharFilePath);
65
66    // 3. Pharアーカイブ内のファイルエントリを取得し、PharFileInfo::isFile() で確認します。
67    // 'example_file.txt' はPharアーカイブ内のファイルなので、isFile()はtrueを返します。
68    $fileInfo = $phar['example_file.txt']; // PharFileInfoオブジェクトを取得
69    if ($fileInfo->isFile()) {
70        echo "エントリ '{$fileInfo->getFilename()}' はファイルです。\n";
71    } else {
72        echo "エントリ '{$fileInfo->getFilename()}' はファイルではありません。\n";
73    }
74
75    // 4. Pharアーカイブ内のディレクトリエントリを取得し、PharFileInfo::isFile() で確認します。
76    // 'example_dir' はPharアーカイブ内のディレクトリなので、isFile()はfalseを返します。
77    $dirInfo = $phar['example_dir']; // PharFileInfoオブジェクトを取得
78    if ($dirInfo->isFile()) {
79        echo "エントリ '{$dirInfo->getFilename()}' はファイルです。\n";
80    } else {
81        echo "エントリ '{$dirInfo->getFilename()}' はファイルではありません。\n";
82    }
83
84} catch (PharException $e) {
85    // Phar関連の操作中に発生した例外を捕捉し、エラーメッセージを出力します。
86    echo "Pharアーカイブの操作中にエラーが発生しました: " . $e->getMessage() . "\n";
87} finally {
88    // 5. クリーンアップ: スクリプトの終了時に、作成したPharファイルを削除します。
89    if (file_exists($pharFilePath)) {
90        unlink($pharFilePath);
91        echo "一時的なPharアーカイブ '{$pharFilePath}' を削除しました。\n";
92    }
93}

PharFileInfo::isFile()は、PHPで複数のファイルやリソースを一つにまとめた「Pharアーカイブ」の中から、個々の要素（エントリ）が通常のファイルであるかどうかを判別するためのメソッドです。

Pharアーカイブは、PHPアプリケーションを単一のファイルとして配布・実行する際に利用され、その内部にはファイルやディレクトリが階層的に含まれています。このメソッドはPharFileInfoクラスに属し、アーカイブ内の特定のエントリがファイルかディレクトリかなどをプログラムで確認する際に役立ちます。

引数は必要なく、戻り値はbool（真偽値）です。対象のエントリがファイルであればtrueを返し、ディレクトリや他の種類のものであればfalseを返します。

サンプルコードでは、まずテスト用のPharアーカイブを作成し、その中にexample_file.txtというファイルとexample_dirというディレクトリを追加しています。example_file.txtのエントリに対してisFile()を呼び出すとtrueが返され、example_dirのエントリに対してはfalseが返されることで、メソッドの挙動が明確に示されています。これにより、Pharアーカイブ内の要素の種類に応じて適切な処理を分岐させることが可能になります。

Copy
1<?php
2
3/**
4 * PharFileInfo::isFile() メソッドの使用例
5 *
6 * このスクリプトは、一時的なPharアーカイブを作成し、
7 * そのアーカイブ内の特定のエントリが通常のファイルであるかどうかを
8 * PharFileInfo::isFile() メソッドを使って確認する方法を示します。
9 *
10 * 注意: このコードを実行するには、php.ini で 'phar.readonly = Off' が設定されている必要があります。
11 *       または、PHP CLI で '-d phar.readonly=0' オプションを付けて実行することも可能です。
12 */
13
14// 一時的なPharアーカイブのファイルパスを定義
15$pharFilePath = __DIR__ . '/example.phar';
16$fileName1 = 'document.txt';           // アーカイブ内の通常のファイル
17$dirName1 = 'data/';                   // アーカイブ内のディレクトリ
18$fileName2 = 'data/report.pdf';        // アーカイブ内のディレクトリ内のファイル
19
20// --- Pharアーカイブの作成フェーズ ---
21try {
22    // 既存のアーカイブがあれば削除し、新しいPharアーカイブを作成します。
23    // Pharコンストラクタは、作成するPharファイルのパス、フラグ、エイリアスを引数にとります。
24    // フラグ '0' は特別なオプションがないことを意味します。
25    $phar = new Phar($pharFilePath, 0, 'example.phar');
26
27    // アーカイブを書き込みモードに設定します。
28    // これにより、複数の操作を一度に行うことができ、パフォーマンスが向上します。
29    $phar->startBuffering();
30
31    // アーカイブに通常のファイルを追加します。
32    // addFromString(アーカイブ内のパス, ファイルの内容)
33    $phar->addFromString($fileName1, "This is the content of document.txt.");
34
35    // 空のディレクトリをアーカイブに追加します。
36    $phar->addEmptyDir($dirName1);
37
38    // ディレクトリ内にファイルを追加します。
39    $phar->addFromString($fileName2, "This is the content of report.pdf.");
40
41    // アーカイブの変更を確定し、書き込みモードを終了します。
42    $phar->stopBuffering();
43
44    echo "Pharアーカイブが正常に作成されました: " . $pharFilePath . PHP_EOL;
45
46} catch (Exception $e) {
47    echo "Pharアーカイブの作成中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
48    // エラーが発生した場合、クリーンアップ後にスクリプトを終了します。
49    if (file_exists($pharFilePath)) {
50        unlink($pharFilePath);
51    }
52    exit(1);
53}
54
55// --- PharFileInfo::isFile() メソッドのテストフェーズ ---
56try {
57    // 作成したPharアーカイブを読み込みモードで開きます。
58    // 既存のPharアーカイブを操作するには、新しいPharオブジェクトを作成します。
59    $phar = new Phar($pharFilePath);
60
61    echo "\n--- PharFileInfo::isFile() メソッドのテスト ---" . PHP_EOL;
62
63    // 1. 通常のファイルのエントリをテストします。
64    // Phar::offsetGet() は、指定された内部パスに対応する PharFileInfo オブジェクトを返します。
65    $fileInfo1 = $phar->offsetGet($fileName1);
66    echo "エントリ '{$fileName1}' は通常のファイルですか？ " . ($fileInfo1->isFile() ? 'はい' : 'いいえ') . PHP_EOL; // 期待値: はい
67
68    // 2. ディレクトリのエントリをテストします。
69    $fileInfo2 = $phar->offsetGet($dirName1);
70    echo "エントリ '{$dirName1}' は通常のファイルですか？ " . ($fileInfo2->isFile() ? 'はい' : 'いいえ') . PHP_EOL; // 期待値: いいえ
71
72    // 3. ディレクトリ内のファイルのエントリをテストします。
73    $fileInfo3 = $phar->offsetGet($fileName2);
74    echo "エントリ '{$fileName2}' は通常のファイルですか？ " . ($fileInfo3->isFile() ? 'はい' : 'いいえ') . PHP_EOL; // 期待値: はい
75
76    // 4. 存在しないエントリのテスト。
77    // Phar::offsetGet() は、存在しないエントリを指定した場合に UnexpectedValueException をスローします。
78    // そのため、isFile() を呼び出す前にエントリの存在を確認するべきです（Phar::offsetExists() などで）。
79    try {
80        $nonExistent = $phar->offsetGet('non_existent.txt');
81        echo "エントリ 'non_existent.txt' は通常のファイルですか？ " . ($nonExistent->isFile() ? 'はい' : 'いいえ') . PHP_EOL;
82    } catch (UnexpectedValueException $e) {
83        echo "エントリ 'non_existent.txt' はPharアーカイブ内に存在しないため、"
84             . "Phar::offsetGet() が例外を投げました: " . $e->getMessage() . PHP_EOL;
85    }
86
87} catch (PharException $e) {
88    echo "Pharアーカイブの読み込み中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
89} catch (Exception $e) {
90    echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
91} finally {
92    // --- 後処理フェーズ ---
93    // 作成したPharファイルを削除します。
94    if (file_exists($pharFilePath)) {
95        unlink($pharFilePath);
96        echo "\nPharアーカイブを削除しました: " . $pharFilePath . PHP_EOL;
97    }
98}

PHPのPharFileInfo::isFile()メソッドは、Pharアーカイブという、複数のPHP関連ファイルを一つのアーカイブファイルにまとめる際に利用される機能です。このメソッドは、アーカイブ内に格納されている個々のファイルやディレクトリ（エントリ）を表すPharFileInfoオブジェクトに対して使用されます。

具体的には、対象のエントリが「通常のファイル」であるかどうかを判別するために使われます。例えば、テキストファイルや画像ファイル、PDFファイルといったデータが「通常のファイル」に該当し、ディレクトリ（フォルダ）とは区別されます。このメソッドには引数はなく、単純に呼び出すだけで判定を行います。

戻り値はbool（真偽値）型です。もし対象のエントリが通常のファイルであればtrue（真）を返し、もしそれがディレクトリであったり、存在しないエントリ、あるいはシンボリックリンクなどの特別なファイル種類であればfalse（偽）を返します。これにより、アーカイブ内の要素を種類に応じて適切に処理する際に役立ちます。