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

Copy
1<?php
2
3// 一時的なPharアーカイブのファイル名を定義します。
4$pharFileName = 'my_application.phar';
5
6// --- 事前準備: 既存のPharファイルをクリーンアップ ---
7// スクリプトが複数回実行されても、常にクリーンな状態から開始できるようにします。
8if (file_exists($pharFileName)) {
9    unlink($pharFileName);
10}
11// PHPによっては、Phar作成時にメタデータファイル (.meta) も作成される場合があります。
12if (file_exists($pharFileName . '.meta')) {
13    unlink($pharFileName . '.meta');
14}
15
16echo "--- Phar::hasChildren() メソッドの使用例 ---" . PHP_EOL . PHP_EOL;
17
18try {
19    // 1. 新しいPharアーカイブを作成します。
20    // 第一引数にファイルパス、第二引数にフラグ（今回はPhar::CURRENT_MODE_WRITEで書き込み可能を指定）、
21    // 第三引数にエイリアス（Phar内部での参照名）を指定します。
22    $phar = new Phar($pharFileName, Phar::CURRENT_MODE_WRITE, $pharFileName);
23
24    // 書き込み操作をバッファリングすることで、多数のファイルを扱う際のパフォーマンスを向上させます。
25    $phar->startBuffering();
26
27    // 2. アーカイブにファイルや空のディレクトリを追加します。
28    // これらの追加されたエントリが、Phar::hasChildren() メソッドで「子」として認識されます。
29    $phar->addFromString('index.php', '<?php echo "Hello from my application!";');
30    $phar->addFromString('config/settings.ini', '[database]\nhost=localhost\nuser=admin');
31    $phar->addEmptyDir('assets'); // 空のディレクトリも子エントリとしてカウントされます。
32    $phar->addFromString('assets/image.png', 'This is a placeholder for an image.');
33
34    // バッファリングを終了し、すべての変更をPharファイルに書き込みます。
35    $phar->stopBuffering();
36
37    echo "Pharアーカイブ '{$pharFileName}' を作成し、複数のファイルとディレクトリを追加しました。" . PHP_EOL;
38
39    // 3. 作成したPharアーカイブを読み込みモードで開きます。
40    // Phar::hasChildren() メソッドは、このPharオブジェクトに対して呼び出します。
41    // ここでは、新しいPharオブジェクトを作成して、先ほど作成したPharファイルを読み込みます。
42    $pharRead = new Phar($pharFileName);
43
44    // 4. hasChildren() メソッドを呼び出し、結果を表示します。
45    // このメソッドは、現在のPharオブジェクトが子エントリ（ファイルやディレクトリ）を
46    // 持っているかどうかを論理値 (true/false) で返します。
47    // Pharアーカイブは内部にコンテンツを持つことを前提とするため、通常は true を返します。
48    $hasChildren = $pharRead->hasChildren();
49
50    echo "Pharアーカイブ '{$pharFileName}' は子エントリを持っていますか？: ";
51    echo ($hasChildren ? "はい (true)" : "いいえ (false)") . PHP_EOL;
52
53} catch (Exception $e) {
54    // Pharアーカイブの作成や操作中にエラーが発生した場合、ここで例外を捕捉してメッセージを表示します。
55    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
56} finally {
57    // --- 後処理: 作成したPharファイルを削除 ---
58    // サンプルコードの実行後に不要なファイルが残らないようにクリーンアップします。
59    if (file_exists($pharFileName)) {
60        unlink($pharFileName);
61        echo "Pharアーカイブ '{$pharFileName}' を削除しました。" . PHP_EOL;
62    }
63    if (file_exists($pharFileName . '.meta')) {
64        unlink($pharFileName . '.meta');
65        echo "メタデータファイル '{$pharFileName}.meta' を削除しました。" . PHP_EOL;
66    }
67}
68
69echo PHP_EOL . "--- 処理完了 ---" . PHP_EOL;
70

Phar::hasChildren()メソッドは、PHPのPharアーカイブが内部にファイルやディレクトリといった「子エントリ」を含んでいるかどうかを判定するために使用されます。このメソッドは引数を必要とせず、戻り値として真偽値（trueまたはfalse）を返します。

サンプルコードでは、まず一時的なPharアーカイブファイルを作成し、その中にaddFromString()メソッドでPHPファイルや設定ファイル、addEmptyDir()メソッドで空のディレクトリなど、複数のコンテンツを追加しています。これらの追加されたファイルやディレクトリが「子エントリ」として扱われます。

その後、作成したPharアーカイブを読み込みモードで再度開いたPharオブジェクトに対してhasChildren()メソッドを呼び出しています。アーカイブに子エントリが追加されているため、このメソッドはtrueを返します。これにより、Pharアーカイブが空ではないことを確認できます。このメソッドは、特定のPharアーカイブがコンテンツを持っているか否かをプログラムで判断したい場合に非常に便利です。

Copy
1<?php
2
3/**
4 * Phar::hasChildren メソッドのサンプルコード
5 *
6 * この関数は、Pharアーカイブを作成し、その中の各エントリが子要素（他のファイルやディレクトリ）を
7 * 持つかどうかを Phar::hasChildren メソッドを使って確認する方法を示します。
8 * システムエンジニアを目指す初心者の方にも理解しやすいように、基本的なPharアーカイブの
9 * 作成、内容追加、読み込み、そして特定の特性（子要素の有無）のチェックを簡潔にまとめています。
10 *
11 * キーワード「php hasproperty」に直接対応するものではありませんが、
12 * ここではPharアーカイブ内のエントリが「子要素を持つ」という特性があるかを判定するという点で
13 * 関連性があると考えています。
14 */
15function demonstratePharHasChildren(): void
16{
17    // 一時的なPharアーカイブのパスを定義します。
18    // スクリプトが動作するディレクトリに作成されます。
19    $pharPath = __DIR__ . '/sample_archive.phar';
20    $pharAlias = 'sample_archive.phar'; // Pharに設定するエイリアス
21
22    // 既存のPharアーカイブが存在する場合、このスクリプトが安全に実行できるよう削除します。
23    // .pharだけでなく、圧縮されたPharファイル（.gzなど）も削除します。
24    foreach (glob($pharPath . '*') as $file) {
25        if (file_exists($file)) {
26            unlink($file);
27        }
28    }
29
30    try {
31        // 1. Pharアーカイブの作成準備
32        echo "Pharアーカイブ '{$pharPath}' の作成を開始します...\n";
33
34        // 新しいPharアーカイブを書き込みモードで作成します。
35        // 第1引数: 作成するPharファイルのパス
36        // 第2引数: フラグ (0はデフォルト動作)
37        // 第3引数: このPharを参照する際のエイリアス名
38        $phar = new Phar($pharPath, 0, $pharAlias);
39
40        // Pharのバッファリングを開始し、複数のファイル追加処理を高速化します。
41        $phar->startBuffering();
42
43        // アーカイブ内にディレクトリ構造とファイルを追加します。
44        $phar->addEmptyDir('assets'); // 「assets」という名前のディレクトリを追加
45        $phar->addEmptyDir('config'); // 「config」という名前のディレクトリを追加
46        $phar->addFromString('index.php', '<?php echo "Hello from Phar!";'); // ルートにファイルを追加
47        $phar->addFromString('assets/style.css', 'body { color: blue; }'); // 「assets」ディレクトリ内にファイルを追加
48        $phar->addFromString('config/settings.json', '{"app_name": "MyApp"}'); // 「config」ディレクトリ内にファイルを追加
49        $phar->addEmptyDir('config/logs'); // 「config」ディレクトリ内に空のディレクトリを追加
50
51        // バッファリングを終了し、これまでの変更をPharアーカイブに書き込みます。
52        $phar->stopBuffering();
53        echo "Pharアーカイブの作成が完了しました。\n\n";
54
55        // 2. Phar::hasChildren の利用
56        echo "Pharアーカイブ内の各エントリが子要素を持つか確認します:\n";
57
58        // Pharオブジェクト自体がPHPのRecursiveIteratorインターフェースを実装しているため、
59        // RecursiveIteratorIteratorでラップすることで、アーカイブ内のディレクトリ構造を
60        // 再帰的に（深掘りして）辿ることができます。
61        $pharIterator = new RecursiveIteratorIterator(
62            $phar, // 作成したPharオブジェクトを直接渡します。
63            RecursiveIteratorIterator::SELF_FIRST // 親要素と子要素の両方を訪問するモード
64        );
65
66        // ループでアーカイブ内の各エントリを処理します。
67        // Phar::hasChildren は、イテレータの現在の位置にあるエントリが子要素を持つか（つまりディレクトリか）を判断します。
68        foreach ($pharIterator as $entryName => $fileInfo) {
69            $depth = $pharIterator->getDepth(); // 現在の階層深度を取得
70            $indent = str_repeat('  ', $depth); // 階層の深さに応じてインデントを生成
71
72            // RecursiveIteratorIteratorのgetInnerIterator()メソッドを使って、
73            // 現在のレベルのPharイテレータ（Pharオブジェクト）を取得し、
74            // そのPharオブジェクトのhasChildren()メソッドを呼び出します。
75            // これにより、現在のエントリがディレクトリであり、中に他のエントリが存在するかを確認します。
76            $hasChildren = $pharIterator->getInnerIterator()->hasChildren();
77
78            // エントリがファイルかディレクトリかを判断します。
79            $type = $fileInfo->isDir() ? 'ディレクトリ' : 'ファイル';
80
81            // 結果を表示します。
82            echo sprintf(
83                "%s- %s: '%s' (子要素を持つ: %s)\n",
84                $indent,
85                $type,
86                $entryName,
87                $hasChildren ? 'はい' : 'いいえ'
88            );
89        }
90        echo "\n";
91
92    } catch (PharException $e) {
93        // Phar操作中にエラーが発生した場合の処理です。
94        echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
95        // エラーが発生した場合は、デバッグのためにPharファイルを残すこともあります。
96        return;
97    } finally {
98        // 3. クリーンアップ
99        // サンプルコードの実行後、作成したPharアーカイブを削除して環境をクリーンアップします。
100        foreach (glob($pharPath . '*') as $file) {
101            if (file_exists($file)) {
102                unlink($file);
103                echo "Pharアーカイブ関連ファイル '{$file}' を削除しました。\n";
104            }
105        }
106    }
107}
108
109// 上記で定義した関数を実行します。
110demonstratePharHasChildren();

PHP 8のPhar::hasChildrenメソッドは、Phar（PHPアーカイブ）ファイル内で現在処理しているエントリが、さらに子要素（サブディレクトリやファイル）を持っているかどうかを確認するために使用されます。このメソッドは引数を必要とせず、真偽値（bool）を返します。具体的には、そのエントリが子要素を持つ場合はtrueを、持たない場合はfalseを返します。これは、実質的にそのエントリがディレクトリであり、内部に他のエントリを含むかどうかを判断するのに役立ちます。

サンプルコードでは、まず複数のファイルやディレクトリを含むPharアーカイブを作成します。次に、RecursiveIteratorIteratorを用いてアーカイブ内の各エントリを階層的に走査しながら、それぞれのエントリに対してhasChildrenメソッドを呼び出しています。例えば、assetsやconfigのようなディレクトリは子要素を持つためtrueと判定され、index.phpやstyle.cssのようなファイルは子要素を持たないためfalseと判定される様子が示されています。これにより、Pharアーカイブ内の複雑な構造をプログラムで効率的に分析することが可能になります。キーワード「php hasproperty」とは直接の関連はありませんが、このメソッドはPharエントリの「子要素を持つ」という特性を確認する点で関連性があると言えます。