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

Copy
1<?php
2
3/**
4 * PharFileInfo::isDir() の使用例を示します。
5 * この関数は一時的なPharアーカイブを作成し、その中のエントリがディレクトリかどうかを判定します。
6 *
7 * システムエンジニアを目指す初心者の方へ:
8 * このコードは、PHPのPhar (PHP Archive) 拡張機能を使って、
9 * 複数のファイルを一つのアーカイブファイルにまとめる方法と、
10 * そのアーカイブ内の要素（ファイルやディレクトリ）をプログラムで識別する方法を示します。
11 * `PharFileInfo::isDir()` メソッドは、アーカイブ内の特定の要素がディレクトリである場合に `true` を返します。
12 */
13function demonstratePharFileInfoIsDir(): void
14{
15    // 一時的なPharファイル名と、その中に含めるコンテンツ用のディレクトリ名を定義します。
16    // sys_get_temp_dir() でシステムのテンポラリディレクトリを取得し、
17    // uniqid() でユニークな名前を生成して、他のファイルと衝突しないようにします。
18    $pharFileName = sys_get_temp_dir() . '/my_temp_archive_' . uniqid() . '.phar';
19    $sourceDir = sys_get_temp_dir() . '/phar_contents_' . uniqid();
20
21    try {
22        // --------------------------------------------------
23        // 1. Pharアーカイブ作成用の準備
24        // --------------------------------------------------
25        // Pharアーカイブに含める一時的なコンテンツディレクトリを作成し、
26        // サブディレクトリとファイルをその中に配置します。
27        // これらは後でPharアーカイブ内に格納されます。
28        mkdir($sourceDir);
29        mkdir($sourceDir . '/dir1'); // ディレクトリを作成
30        file_put_contents($sourceDir . '/file2.txt', 'This is file2.txt in the archive.'); // ファイルを作成
31        file_put_contents($sourceDir . '/dir1/file1.txt', 'This is file1.txt in dir1.'); // サブディレクトリ内にファイルを作成
32
33        echo "一時的なコンテンツディレクトリが作成されました: " . $sourceDir . PHP_EOL;
34
35        // --------------------------------------------------
36        // 2. Pharアーカイブを作成する
37        // --------------------------------------------------
38        echo "Pharアーカイブを作成しています: " . $pharFileName . PHP_EOL;
39
40        // 既に同じ名前のPharファイルが存在する場合は削除します。
41        // これにより、スクリプトを複数回実行してもエラーになりません。
42        if (file_exists($pharFileName)) {
43            unlink($pharFileName);
44        }
45
46        // Pharオブジェクトを新規作成します。
47        // これにより、指定したファイル名で新しいPharアーカイブが作成されます。
48        $phar = new Phar($pharFileName);
49        // バッファリングを開始し、変更を一時的にメモリに保持します。
50        $phar->startBuffering();
51        // buildFromDirectory() メソッドを使用して、指定したディレクトリの内容（ファイルとサブディレクトリ）を
52        // まとめてPharアーカイブに追加します。
53        $phar->buildFromDirectory($sourceDir);
54        // Pharアーカイブを実行可能にするためのスタブ（起動コード）を設定します。
55        // これがないと、PharファイルをPHPスクリプトとして直接実行できません。
56        $phar->setStub($phar->createDefaultStub('index.php'));
57        // バッファリングを停止し、変更をPharファイルに書き込みます。
58        $phar->stopBuffering();
59        echo "Pharアーカイブが正常に作成されました。" . PHP_EOL;
60
61        // --------------------------------------------------
62        // 3. Pharアーカイブからエントリを読み込み、isDir() を使用する
63        // --------------------------------------------------
64        echo PHP_EOL . "Pharアーカイブ内のエントリを調べています:" . PHP_EOL;
65
66        // 作成したPharアーカイブを読み込みモードで再度開きます。
67        // これにより、アーカイブ内のコンテンツにアクセスできるようになります。
68        $pharReader = new Phar($pharFileName);
69
70        // RecursiveIteratorIterator と Phar を組み合わせて、
71        // Pharアーカイブ内のすべてのエントリ（ファイルとディレクトリ）をループ処理します。
72        // これにより、サブディレクトリ内のエントリも再帰的に取得できます。
73        foreach (new RecursiveIteratorIterator($pharReader) as $fileInfo) {
74            // $fileInfo は PharFileInfo クラスのインスタンスです。
75            // Pharアーカイブ内の相対パスを取得し、表示を簡潔にします。
76            // 例: "phar:///tmp/my_temp_archive_.../dir1/file1.txt" から "dir1/file1.txt" を抽出します。
77            $relativePath = str_replace('phar://' . $pharFileName . '/', '', $fileInfo->getPathname());
78
79            // PharFileInfo::isDir() メソッドを使用して、現在のエントリがディレクトリであるかを判定します。
80            // このメソッドは引数を取らず、ディレクトリであれば `true` を、ファイルであれば `false` を返します。
81            if ($fileInfo->isDir()) {
82                echo "  - '{$relativePath}' はディレクトリです。" . PHP_EOL;
83            } else {
84                echo "  - '{$relativePath}' はファイルです。" . PHP_EOL;
85            }
86        }
87
88    } catch (Exception $e) {
89        // Phar操作中にエラーが発生した場合、メッセージを出力します。
90        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
91    } finally {
92        // --------------------------------------------------
93        // 4. クリーンアップ
94        // --------------------------------------------------
95        // スクリプトの実行後、作成した一時ファイルとディレクトリを削除します。
96        // これにより、システムが不要なファイルでいっぱいになるのを防ぎます。
97
98        // Pharアーカイブファイルを削除
99        if (file_exists($pharFileName)) {
100            unlink($pharFileName);
101            echo PHP_EOL . "Pharアーカイブファイルが削除されました: " . $pharFileName . PHP_EOL;
102        }
103
104        // 一時的なコンテンツディレクトリを再帰的に削除
105        if (is_dir($sourceDir)) {
106            // RecursiveDirectoryIterator を使ってディレクトリ内の全要素を走査
107            // SKIP_DOTS フラグで '.' と '..' をスキップします。
108            $it = new RecursiveDirectoryIterator($sourceDir, RecursiveDirectoryIterator::SKIP_DOTS);
109            // CHILD_FIRST フラグで子要素（ファイルやサブディレクトリの内容）を先に処理し、
110            // その後に親ディレクトリを処理します。これにより、ディレクトリが空になってから削除できます。
111            $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
112            foreach ($files as $file) {
113                if ($file->isDir()) {
114                    // ディレクトリの場合、rmdir() で削除
115                    rmdir($file->getRealPath());
116                } else {
117                    // ファイルの場合、unlink() で削除
118                    unlink($file->getRealPath());
119                }
120            }
121            // 全てのファイルとサブディレクトリが削除された後、空になったルートディレクトリを削除
122            rmdir($sourceDir);
123            echo "一時的なコンテンツディレクトリが削除されました: " . $sourceDir . PHP_EOL;
124        }
125    }
126}
127
128// サンプルコードの実行
129demonstratePharFileInfoIsDir();

PHP 8のPharFileInfo::isDir()メソッドは、PHPアプリケーションをアーカイブ化するPhar拡張機能において、Pharアーカイブ内の特定の要素がディレクトリであるかを判定するために使用されます。このメソッドはPharFileInfoクラスに属し、引数を一切取らず、判定結果を真偽値（trueまたはfalse）で返します。具体的には、指定された要素がディレクトリであればtrueを、ファイルであればfalseを返します。

このサンプルコードは、まず一時的なPharアーカイブファイルを作成し、その中にいくつかのファイルとディレクトリを格納します。その後、作成されたPharアーカイブを開き、その内部に含まれるすべてのエントリを一つずつ調べています。ループ処理中に取得される各エントリはPharFileInfoオブジェクトとして扱われ、そのオブジェクトに対してisDir()メソッドが呼び出されます。これにより、各エントリがファイルなのかディレクトリなのかをプログラムで正確に識別し、その結果を出力しています。システム開発において、Pharアーカイブを扱う際に、内部の構造を動的に解析し、ファイルとディレクトリを適切に処理する場面で非常に有用な機能です。また、実行後に作成した一時ファイルやディレクトリを削除し、環境をクリーンアップしています。

Copy
1<?php
2
3// Phar拡張がPHPにロードされているかを確認します。
4// Phar拡張は、PHPアプリケーションを単一のアーカイブファイルにパッケージ化するために使用されます。
5if (!extension_loaded('phar')) {
6    echo "エラー: Phar拡張がロードされていません。php.iniでPhar拡張を有効にしてください。\n";
7    exit(1);
8}
9
10/**
11 * Pharアーカイブを作成し、その中のエントリがディレクトリかどうかを判定するサンプル関数です。
12 * この関数は、PharFileInfo::isDir() メソッドの具体的な使い方をシステムエンジニアを目指す初心者向けに示します。
13 */
14function demonstratePharIsDirectory(): void
15{
16    // 一時的なPharアーカイブのファイルパスを定義します。
17    // スクリプトが実行されているディレクトリに「temp_example.phar」という名前で作成されます。
18    $pharPath = __DIR__ . '/temp_example.phar';
19
20    // エラーが発生した場合でも、作成した一時ファイルを確実に削除するためにtry-finallyブロックを使用します。
21    try {
22        // --- 1. Pharアーカイブの作成準備 ---
23        // 以前の実行で残ったPharアーカイブがあれば、まず削除します。
24        if (file_exists($pharPath)) {
25            unlink($pharPath);
26        }
27
28        // 新しいPharオブジェクトを作成します。
29        // 第1引数: 作成するPharファイルのパス。
30        // 第2引数: ファイルモード（ここでは読み書き可能）。
31        // 第3引数: Pharアーカイブのエイリアス（Pharを識別するための名前）。
32        $phar = new Phar($pharPath, 0, 'temp_example.phar');
33
34        // Pharアーカイブのスタブを設定します。
35        // これはPharアーカイブが直接PHPスクリプトとして実行されたときに動作するコードです。
36        $phar->setStub($phar->createDefaultStub('index.php'));
37
38        // アーカイブへの書き込みを開始します。これにより、複数のファイルを効率的に追加できます。
39        $phar->startBuffering();
40
41        // --- 2. アーカイブにファイルとディレクトリのエントリを追加 ---
42        // 通常のファイルをアーカイブに追加します。
43        $phar->addFromString('file_a.txt', 'これはアーカイブ内の最初のファイルです。');
44
45        // ディレクトリ構造を持つファイルを追加します。
46        // パスにスラッシュが含まれている場合、Pharは自動的に「my_dir」ディレクトリを作成します。
47        $phar->addFromString('my_dir/file_b.txt', 'これは "my_dir" ディレクトリ内のファイルです。');
48
49        // 明示的に空のディレクトリをアーカイブに追加します。
50        $phar->addEmptyDir('empty_dir');
51
52        // アーカイブへの書き込みを終了し、変更を保存します。
53        $phar->stopBuffering();
54        echo "Pharアーカイブが正常に作成されました: " . $pharPath . "\n";
55
56        // --- 3. 作成したPharアーカイブを読み込み、エントリを検査 ---
57        // 作成したPharアーカイブを読み込みモードで開きます。
58        // これにより、アーカイブ内の個々のファイルやディレクトリにアクセスできるようになります。
59        $pharArchive = new Phar($pharPath);
60
61        echo "\nPharアーカイブ内のエントリを検査しています:\n";
62        // アーカイブ内の各エントリ（ファイルやディレクトリ）をループで処理します。
63        foreach ($pharArchive as $entryName => $fileInfo) {
64            // $fileInfo は PharFileInfo クラスのインスタンスです。
65            // これは SplFileInfo を継承しており、ファイル名、サイズ、タイプなどの情報にアクセスできます。
66            /** @var PharFileInfo $fileInfo */
67            echo "  エントリ名: " . $entryName;
68
69            // PharFileInfo::isDir() メソッドを使用して、現在のエントリがディレクトリであるかを判定します。
70            // このメソッドは、エントリがディレクトリであれば true、ファイルであれば false を返します。
71            if ($fileInfo->isDir()) {
72                echo " - タイプ: ディレクトリ\n";
73            } else {
74                echo " - タイプ: ファイル (サイズ: " . $fileInfo->getSize() . " バイト)\n";
75            }
76        }
77
78    } catch (PharException $e) {
79        // Phar関連の操作中にエラーが発生した場合、エラーメッセージを表示します。
80        echo "Pharアーカイブの作成またはアクセス中にエラーが発生しました: " . $e->getMessage() . "\n";
81    } finally {
82        // --- 4. クリーンアップ ---
83        // サンプルコードの実行が終了したら、作成した一時Pharアーカイブを削除します。
84        if (file_exists($pharPath)) {
85            unlink($pharPath);
86            echo "\nPharアーカイブをクリーンアップしました: " . $pharPath . "\n";
87        }
88    }
89}
90
91// 上記で定義したサンプル関数を実行します。
92demonstratePharIsDirectory();

PHP 8で提供されるPharFileInfo::isDir()メソッドは、PHPアプリケーションを単一のアーカイブファイルとして扱うためのPhar拡張の一部です。このメソッドは、Pharアーカイブ内に含まれる特定の要素（エントリ）がディレクトリであるかどうかを判定する目的で使用されます。引数は必要なく、エントリがディレクトリであればtrueを、ファイルであればfalseを真偽値（bool）として返します。

サンプルコードでは、まず「temp_example.phar」という一時的なPharアーカイブを作成しています。このアーカイブには、「file_a.txt」というファイルや、「my_dir/file_b.txt」のようなディレクトリ構造を持つファイル、さらに「empty_dir」という空のディレクトリが追加されます。

その後、作成したPharアーカイブを読み込み、その中にある各エントリを一つずつ確認しています。ループ処理内で$fileInfo->isDir()を呼び出すことで、現在扱っているエントリがディレクトリなのか、それともファイルなのかを正確に判別し、その結果を出力しています。この機能により、Pharアーカイブの内部構造をプログラムで確認し、ディレクトリに応じた柔軟な処理を行うことが可能となります。