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

Copy
1<?php
2
3/**
4 * テスト用のディレクトリとファイルをセットアップするヘルパー関数。
5 * システムエンジニア初心者でも分かりやすいように、具体的なディレクトリ構造を作成します。
6 *
7 * @param string $basePath 作成するテストディレクトリのルートパス
8 */
9function setupTestDirectory(string $basePath): void
10{
11    if (!is_dir($basePath)) {
12        mkdir($basePath, 0777, true);
13    }
14
15    // subdir1: 子要素を持つディレクトリ（ファイルと空のサブディレクトリを含む）
16    // RecursiveFilterIterator::hasChildren() の動作をデモンストレーションするために使用します。
17    mkdir($basePath . '/subdir1', 0777, true);
18    file_put_contents($basePath . '/subdir1/file_in_subdir1.txt', 'This is a file in subdir1.');
19    mkdir($basePath . '/subdir1/sub_subdir_a', 0777, true); // このディレクトリは空
20
21    // subdir2: 子要素を持たないディレクトリ（空のディレクトリ）
22    mkdir($basePath . '/subdir2', 0777, true);
23
24    // root_file.txt: ルートディレクトリ直下のファイル
25    // DirectoryOnlyFilterIterator によってフィルタリングされるため、出力には現れません。
26    file_put_contents($basePath . '/root_file.txt', 'This is a file in the root directory.');
27}
28
29/**
30 * テスト用ディレクトリをクリーンアップするヘルパー関数。
31 * サンプルコードが実行後に環境をきれいに保つようにします。
32 *
33 * @param string $basePath 削除するテストディレクトリのルートパス
34 */
35function cleanupTestDirectory(string $basePath): void
36{
37    if (!is_dir($basePath)) {
38        return;
39    }
40
41    // RecursiveIteratorIterator を使用して、ディレクトリ内のすべてのファイルとサブディレクトリを再帰的に削除します。
42    $iterator = new RecursiveIteratorIterator(
43        new RecursiveDirectoryIterator($basePath, RecursiveDirectoryIterator::SKIP_DOTS),
44        RecursiveIteratorIterator::CHILD_FIRST
45    );
46
47    foreach ($iterator as $file) {
48        if ($file->isDir()) {
49            @rmdir($file->getRealPath()); // エラー発生時は無視
50        } else {
51            @unlink($file->getRealPath()); // エラー発生時は無視
52        }
53    }
54    @rmdir($basePath); // ルートディレクトリを削除 (エラー発生時は無視)
55}
56
57/**
58 * DirectoryOnlyFilterIterator クラス
59 * RecursiveFilterIterator を継承し、ディレクトリのみを通過させるフィルタリングロジックを実装します。
60 */
61class DirectoryOnlyFilterIterator extends RecursiveFilterIterator
62{
63    /**
64     * 現在のイテレータ要素を受け入れるかどうかを決定します。
65     * このメソッドは RecursiveFilterIterator の重要な部分で、フィルタリング条件を定義します。
66     *
67     * @return bool 現在の要素がディレクトリであれば true、そうでなければ false。
68     */
69    public function accept(): bool
70    {
71        // current() メソッドは、ラップしているイテレータ (RecursiveDirectoryIterator) の
72        // 現在の要素（SplFileInfo オブジェクト）を返します。
73        return $this->current()->isDir();
74    }
75}
76
77// --- メイン処理の開始 ---
78
79// ユニークな一時ディレクトリを作成し、テスト環境をセットアップします。
80$tempTestDir = sys_get_temp_dir() . '/php_recursive_filter_example_' . uniqid();
81setupTestDirectory($tempTestDir);
82
83try {
84    echo "--- RecursiveFilterIterator::hasChildren() の使用例 ---\n\n";
85
86    // 1. RecursiveDirectoryIterator を作成し、指定されたディレクトリの内容を読み込みます。
87    //    RecursiveDirectoryIterator::SKIP_DOTS は、'.' (現在のディレクトリ) と '..' (親ディレクトリ) を除外します。
88    $directoryIterator = new RecursiveDirectoryIterator(
89        $tempTestDir,
90        RecursiveDirectoryIterator::SKIP_DOTS
91    );
92
93    // 2. DirectoryOnlyFilterIterator で RecursiveDirectoryIterator をラップします。
94    //    これにより、後続のイテレーションではディレクトリのみが考慮されます。
95    $filterIterator = new DirectoryOnlyFilterIterator($directoryIterator);
96
97    // 3. RecursiveIteratorIterator を使用して、フィルタリングされた要素を再帰的にトラバースします。
98    //    RecursiveIteratorIterator::SELF_FIRST は、親要素を先に、その後に子要素を処理する順序を指定します。
99    $recursiveIterator = new RecursiveIteratorIterator(
100        $filterIterator,
101        RecursiveIteratorIterator::SELF_FIRST
102    );
103
104    echo "フィルタリングされた要素の走査と子要素の有無の確認:\n";
105    foreach ($recursiveIterator as $path => $fileInfo) {
106        // RecursiveFilterIterator::hasChildren() を呼び出します。
107        // RecursiveIteratorIterator を使用しているため、$recursiveIterator->getInnerIterator() で
108        // フィルタリングされたイテレータ (DirectoryOnlyFilterIterator) を取得し、
109        // その上で hasChildren() を呼び出します。
110        //
111        // このメソッドは、現在の要素（フィルタリング条件を満たしたもの）が子要素を持ち、
112        // かつその子要素もフィルタリング条件 (accept() メソッド) を満たす場合に true を返します。
113        // 例えば、`subdir1` は `sub_subdir_a` という子ディレクトリを持つため、true を返します。
114        // しかし、`sub_subdir_a` は空のディレクトリなので、それ自体が子要素を持つか確認すると false を返します。
115        $hasChildren = $recursiveIterator->getInnerIterator()->hasChildren();
116
117        echo sprintf(
118            "- %s (タイプ: %s) => 子要素を持つか: %s\n",
119            $fileInfo->getBasename(), // ファイル名またはディレクトリ名
120            $fileInfo->isDir() ? 'ディレクトリ' : 'ファイル',
121            $hasChildren ? 'はい' : 'いいえ'
122        );
123    }
124
125} catch (Exception $e) {
126    // エラーが発生した場合、そのメッセージを表示します。
127    echo "エラーが発生しました: " . $e->getMessage() . "\n";
128} finally {
129    // 処理完了後、作成したテスト用ディレクトリをクリーンアップします。
130    cleanupTestDirectory($tempTestDir);
131    echo "\nテスト用ディレクトリをクリーンアップしました。\n";
132}
133

RecursiveFilterIterator::hasChildren()メソッドは、ファイルシステムなどを再帰的に走査する際に、現在のイテレータ要素が「フィルタリング条件を満たす子要素」を持っているかどうかを判定するために使用されます。このメソッドは引数を取りません。戻り値は真偽値（bool）で、該当する子要素が存在すればtrueを、存在しなければfalseを返します。

特に重要なのは、このメソッドが親クラスであるRecursiveFilterIteratorで定義されているaccept()メソッドのフィルタリング条件を考慮する点です。つまり、子要素自体は存在しても、その子要素がaccept()メソッドで定められた条件を満たさない場合は、hasChildren()はfalseを返します。

サンプルコードでは、DirectoryOnlyFilterIteratorクラスによってディレクトリのみを許可するフィルタリングを行っています。このフィルタリングされたイテレータを通してhasChildren()を呼び出すと、例えばsubdir1はsub_subdir_aという子ディレクトリを持つためtrueを返しますが、subdir2やsub_subdir_aのように子ディレクトリを持たない要素に対してはfalseを返します。これにより、現在の要素がさらに掘り下げて処理すべきディレクトリであるかを効率的に判断することができます。

Copy
1<?php
2
3/**
4 * 特定の条件でファイルをフィルタリングするイテレータクラス。
5 * RecursiveFilterIterator::hasChildren() メソッドの使用例を示します。
6 */
7class MyFileFilterIterator extends RecursiveFilterIterator
8{
9    /**
10     * コンストラクタ
11     *
12     * @param RecursiveIterator $iterator 基になるイテレータ
13     */
14    public function __construct(RecursiveIterator $iterator)
15    {
16        parent::__construct($iterator);
17    }
18
19    /**
20     * 現在の要素を受け入れるかどうかを決定します。
21     * この例では、常に true を返し、全てのファイルとディレクトリを含めます。
22     * (基底イテレータの FilesystemIterator::SKIP_DOTS により "." と ".." は既に除外されています)
23     *
24     * @return bool 要素を受け入れる場合は true、そうでない場合は false
25     */
26    public function accept(): bool
27    {
28        return true;
29    }
30
31    /**
32     * 現在の要素が子要素を持っているかを判断します。
33     *
34     * RecursiveFilterIterator の hasChildren() メソッドは、
35     * 内部的に基底イテレータ (この例では RecursiveDirectoryIterator) の
36     * 現在の要素が子を持つかどうかを判断します。
37     * RecursiveDirectoryIterator の場合、現在の要素がディレクトリであれば true を返します。
38     *
39     * @return bool 子要素を持っている場合は true、そうでない場合は false
40     */
41    public function hasChildren(): bool
42    {
43        // 基底イテレータの hasChildren() メソッドを呼び出します。
44        // RecursiveDirectoryIterator では、現在の要素がディレクトリの場合に true を返します。
45        return parent::hasChildren();
46    }
47}
48
49// --- サンプル実行のための準備 ---
50// 一時ディレクトリとファイルを作成します。
51$testDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_haschildren_example';
52
53// ディレクトリが存在しない場合は作成
54if (!file_exists($testDir)) {
55    mkdir($testDir, 0777, true);
56}
57// ファイルを作成
58file_put_contents($testDir . '/file1.txt', 'This is file1.');
59
60// サブディレクトリ 'subdir_a' を作成
61if (!file_exists($testDir . '/subdir_a')) {
62    mkdir($testDir . '/subdir_a', 0777);
63}
64file_put_contents($testDir . '/subdir_a/file2.txt', 'This is file2.');
65
66// サブサブディレクトリ 'subdir_b' を作成
67if (!file_exists($testDir . '/subdir_a/subdir_b')) {
68    mkdir($testDir . '/subdir_a/subdir_b', 0777);
69}
70file_put_contents($testDir . '/subdir_a/subdir_b/file3.txt', 'This is file3.');
71
72echo "--- RecursiveFilterIterator::hasChildren() の使用例 ---\n\n";
73
74try {
75    // 1. 基になるイテレータを作成します。
76    // RecursiveDirectoryIterator は指定されたディレクトリの内容を反復処理します。
77    // FilesystemIterator::SKIP_DOTS は "." と ".." のエントリを自動的にスキップします。
78    $directoryIterator = new RecursiveDirectoryIterator(
79        $testDir,
80        FilesystemIterator::SKIP_DOTS
81    );
82
83    // 2. カスタムフィルタを適用します。
84    // MyFileFilterIterator は RecursiveDirectoryIterator の上にフィルタリング層を提供します。
85    $filterIterator = new MyFileFilterIterator($directoryIterator);
86
87    // 3. 再帰的なイテレータを作成し、フィルタリングされた要素を処理します。
88    // RecursiveIteratorIterator::SELF_FIRST は、ディレクトリ自身を先に処理し、その後その中の要素を処理します。
89    $recursiveIterator = new RecursiveIteratorIterator(
90        $filterIterator,
91        RecursiveIteratorIterator::SELF_FIRST
92    );
93
94    // フィルタリングされたディレクトリ構造を走査し、各要素の子要素の有無を表示します。
95    foreach ($recursiveIterator as $path => $fileInfo) {
96        // 現在の深度に応じてインデントを作成し、ツリー構造を見やすくします。
97        $indent = str_repeat('  ', $recursiveIterator->getDepth());
98
99        // RecursiveFilterIterator::hasChildren() を呼び出して、現在の要素が子を持つか確認します。
100        // このメソッドは、フィルタリング対象のイテレータが指す要素（ファイルまたはディレクトリ）が
101        // さらに子要素（ファイルやサブディレクトリ）を持っているかどうかを判断します。
102        // RecursiveDirectoryIterator の場合、現在の要素がディレクトリであれば true を返します。
103        $hasChildren = $filterIterator->hasChildren();
104
105        $type = $fileInfo->isDir() ? 'DIR ' : 'FILE';
106        $childrenStatus = $hasChildren ? 'あり' : 'なし';
107
108        echo "{$indent}{$type}: {$fileInfo->getFilename()} (子要素: {$childrenStatus})\n";
109    }
110
111} catch (UnexpectedValueException $e) {
112    echo "エラー: 指定されたディレクトリが存在しないか、アクセスできません: " . $e->getMessage() . "\n";
113} finally {
114    // --- サンプル実行後のクリーンアップ ---
115    // 一時ディレクトリを削除する場合は、以下のコメントを解除してください。
116    // 実際のアプリケーションでは、リソースの解放を適切に行う必要があります。
117    // function recursiveRemoveDirectory(string $dir): void
118    // {
119    //     if (!file_exists($dir)) return;
120    //     $it = new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS);
121    //     $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
122    //     foreach ($files as $file) {
123    //         $file->isDir() ? rmdir($file->getRealPath()) : unlink($file->getRealPath());
124    //     }
125    //     rmdir($dir);
126    // }
127    // recursiveRemoveDirectory($testDir);
128}

PHP 8 の RecursiveFilterIterator::hasChildren() メソッドは、ディレクトリなどの階層構造を持つデータを再帰的に（つまり、深い階層まで順番に）処理する際に、現在見ている要素がさらに子要素（サブファイルやサブディレクトリ）を持っているかを判断するために使用されます。このメソッドは引数を受け取らず、子要素があれば true、なければ false をブール値で返します。

サンプルコードでは、ファイルシステムを探索する RecursiveDirectoryIterator の上に、フィルタリング機能を提供する MyFileFilterIterator を重ねています。RecursiveFilterIterator は、基となるイテレータ（ここではRecursiveDirectoryIterator）が提供する情報に基づいて動作します。hasChildren() メソッドを呼び出すと、基となるイテレータが現在指している要素がディレクトリであれば true を返し、ファイルであれば false を返します。

実際にコードを実行すると、作成された一時ディレクトリ内の各ファイルやディレクトリに対して、hasChildren() の結果が「子要素: あり」または「子要素: なし」として表示されます。これにより、どの要素がさらに掘り下げて処理すべき階層であるかを明確に判別でき、ファイルシステムのツリー構造を効率的にたどりながら、特定の条件を満たす要素だけを抽出するシステムなどで役立ちます。