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

Copy
1<?php
2
3// 1. セットアップ: テスト用のディレクトリ構造を作成
4// この構造は、フィルタリングと hasChildren() の動作を実証するために使用されます。
5$tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'recursive_filter_test_' . uniqid();
6mkdir($tempDir);
7mkdir($tempDir . DIRECTORY_SEPARATOR . 'subdir_with_txt'); // .txt ファイルを含むサブディレクトリ
8mkdir($tempDir . DIRECTORY_SEPARATOR . 'subdir_no_txt');    // .txt ファイルを含まないサブディレクトリ
9
10file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file_root.txt', 'Root TXT file content');
11file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file_root.log', 'Root LOG file content'); // フィルタリングで除外される
12
13file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subdir_with_txt' . DIRECTORY_SEPARATOR . 'file_sub1.txt', 'Subdir1 TXT file content');
14file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subdir_with_txt' . DIRECTORY_SEPARATOR . 'file_sub1.log', 'Subdir1 LOG file content'); // フィルタリングで除外される
15
16// このサブディレクトリは .txt ファイルを含まないため、フィルタリング後には子要素がなくなります。
17file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subdir_no_txt' . DIRECTORY_SEPARATOR . 'file_sub2.log', 'Subdir2 LOG file content'); // フィルタリングで除外される
18
19echo "--- 作成された一時ディレクトリ構造: ---\n";
20echo "{$tempDir}/\n";
21echo "├── file_root.txt\n";
22echo "├── file_root.log\n";
23echo "├── subdir_with_txt/\n";
24echo "│   ├── file_sub1.txt\n";
25echo "│   └── file_sub1.log\n";
26echo "└── subdir_no_txt/\n";
27echo "    └── file_sub2.log\n";
28echo "----------------------------------------------\n\n";
29
30/**
31 * RecursiveCallbackFilterIterator::hasChildren() メソッドの使用例をデモンストレーションします。
32 *
33 * 指定されたパスを基にディレクトリを走査し、特定のフィルタリング条件に基づいて
34 * 各要素が「子要素を持つか」どうかを RecursiveCallbackFilterIterator の hasChildren() メソッドで確認します。
35 *
36 * @param string $basePath 走査を開始するベースパス。
37 */
38function demonstrateRecursiveCallbackFilterIteratorHasChildren(string $basePath): void
39{
40    // 最初に、ディレクトリを再帰的に走査するための RecursiveDirectoryIterator を作成します。
41    // SKIP_DOTS フラグで '.' と '..' エントリをスキップします。
42    $directoryIterator = new RecursiveDirectoryIterator(
43        $basePath,
44        RecursiveDirectoryIterator::SKIP_DOTS
45    );
46
47    // RecursiveCallbackFilterIterator を作成し、フィルタリングルールを定義するコールバック関数を渡します。
48    // このコールバック関数は、各要素がイテレーションに含まれるべきかどうかを決定します。
49    // ここでは、ディレクトリ自体、または拡張子が '.txt' のファイルのみを許可します。
50    $filterIterator = new RecursiveCallbackFilterIterator(
51        $directoryIterator,
52        function (string $currentPath, string $key, RecursiveIterator $iterator) {
53            $fileInfo = $iterator->current(); // 現在の要素の SplFileInfo オブジェクトを取得
54
55            // 要素がディレクトリの場合は常に許可します。
56            if ($fileInfo->isDir()) {
57                return true;
58            }
59
60            // 要素がファイルの場合、その拡張子が '.txt' であれば許可します。
61            if ($fileInfo->isFile() && $fileInfo->getExtension() === 'txt') {
62                return true;
63            }
64
65            // それ以外の要素（例: .log ファイル）は許可せず、フィルタリングで除外します。
66            return false;
67        }
68    );
69
70    // RecursiveIteratorIterator を使って、フィルタリングされた要素を再帰的に走査します。
71    // SELF_FIRST モードは、親要素を最初に処理し、その後で子要素を処理します。
72    $recursiveIterator = new RecursiveIteratorIterator(
73        $filterIterator,
74        RecursiveIteratorIterator::SELF_FIRST
75    );
76
77    echo "--- フィルタリングされた要素の走査と hasChildren() の確認 ---\n";
78    echo "'.log' 拡張子のファイルはフィルタリングで除外されます。\n\n";
79
80    foreach ($recursiveIterator as $path => $fileinfo) {
81        // 現在の要素の深さに応じてインデントを追加し、階層構造を視覚化します。
82        $indent = str_repeat('  ', $recursiveIterator->getDepth());
83
84        echo "{$indent}- {$fileinfo->getFilename()} ";
85
86        // RecursiveCallbackFilterIterator::hasChildren() メソッドを呼び出します。
87        // このメソッドは、現在の要素が「フィルタリング条件に合致する子要素」を
88        // 持っているかどうかを bool 値で返します。
89        //
90        // 例: 'subdir_no_txt' は物理的には 'file_sub2.log' という子ファイルを持ちますが、
91        // フィルタリングによりそのファイルが除外されるため、このディレクトリの hasChildren() は false を返します。
92        if ($filterIterator->hasChildren()) {
93            echo "(フィルター基準で子要素あり)";
94        } else {
95            echo "(フィルター基準で子要素なし)";
96        }
97        echo "\n";
98    }
99    echo "------------------------------------------------------------\n\n";
100}
101
102// デモンストレーション関数を実行します。
103demonstrateRecursiveCallbackFilterIteratorHasChildren($tempDir);
104
105// 2. クリーンアップ: 作成した一時ディレクトリとファイルを削除します。
106// PHP 8 には RecursiveDirectoryIterator の RMDIR_RECURSIVE フラグがないため、
107// 再帰的なディレクトリ削除関数を自作します。
108function rrmdir(string $dir): void
109{
110    if (!is_dir($dir)) {
111        return;
112    }
113    $objects = scandir($dir);
114    foreach ($objects as $object) {
115        if ($object !== "." && $object !== "..") {
116            $path = $dir . DIRECTORY_SEPARATOR . $object;
117            if (is_dir($path) && !is_link($path)) {
118                rrmdir($path); // ディレクトリの場合は再帰的に削除
119            } else {
120                unlink($path); // ファイルの場合は削除
121            }
122        }
123    }
124    rmdir($dir); // 空になったディレクトリを削除
125}
126rrmdir($tempDir);
127echo "--- クリーンアップ: 一時ディレクトリを削除しました。 ---\n";
128

RecursiveCallbackFilterIterator::hasChildren() メソッドは、PHP 8で導入されたイテレータに関する機能です。このメソッドは、RecursiveCallbackFilterIterator クラスのインスタンスに対して呼び出され、引数は取りません。戻り値は bool 型で、現在のイテレータが「フィルタリング条件に合致する子要素」を持っているかどうかを真偽値で返します。

このメソッドの重要な点は、物理的に子要素が存在するかどうかだけでなく、RecursiveCallbackFilterIterator に設定されたコールバック関数によるフィルタリングが適用された後の子要素の有無を判断する点です。

サンプルコードでは、一時ディレクトリ内に複数のファイルとサブディレクトリを作成し、.txt ファイルとディレクトリのみを許可するフィルタリングを適用しています。RecursiveCallbackFilterIterator::hasChildren() は、このフィルタリング条件を満たす子要素がある場合に true を返し、そうでない場合に false を返します。たとえば、物理的には子ファイルが存在しても、そのファイルがフィルタリング条件（例：.txt ファイルのみ）に合致しない場合、hasChildren() は false を返します。これにより、特定の条件で絞り込んだ結果として、現在の要素がさらに子要素を持つかを効率的に判定できます。

Copy
1<?php
2
3/**
4 * Demonstrates the use of RecursiveCallbackFilterIterator::hasChildren() in PHP 8.
5 *
6 * This script creates a temporary directory structure, then uses a
7 * RecursiveCallbackFilterIterator to traverse it. For each element,
8 * it explicitly calls `hasChildren()` to check if the current item
9 * (e.g., a directory) contains further sub-items.
10 *
11 * This concept is analogous to checking if an object "has a property"
12 * in the context of object-oriented programming, but here applied to
13 * checking for the existence of child elements in an iterable structure.
14 */
15
16// --- 1. Setup: Create a temporary directory structure for demonstration ---
17$tempDir = __DIR__ . '/temp_recursive_filter_demo';
18if (!is_dir($tempDir)) {
19    mkdir($tempDir);
20}
21file_put_contents($tempDir . '/file1.txt', 'This is file1.');
22mkdir($tempDir . '/subdir1');
23file_put_contents($tempDir . '/subdir1/file2.txt', 'This is file2.');
24mkdir($tempDir . '/subdir1/emptysubdir'); // An empty subdirectory
25file_put_contents($tempDir . '/subdir1/image.jpg', 'fake image content'); // A non-text file
26mkdir($tempDir . '/subdir2');
27file_put_contents($tempDir . '/subdir2/file3.txt', 'This is file3.');
28
29echo "--- Demonstration of RecursiveCallbackFilterIterator::hasChildren() ---\n";
30echo "Scanning temporary directory: " . realpath($tempDir) . "\n";
31echo "Only '.txt' files and all directories are accepted by the filter.\n";
32echo "---------------------------------------------------------------------\n";
33
34// --- 2. Initialize RecursiveDirectoryIterator ---
35// This iterator will read the contents of the temporary directory, skipping '.' and '..'.
36$directoryIterator = new RecursiveDirectoryIterator(
37    $tempDir,
38    RecursiveDirectoryIterator::SKIP_DOTS
39);
40
41// --- 3. Define the filter callback function ---
42// This callback determines which elements (files or directories) are accepted by the filter.
43// It receives the current SplFileInfo object, its key, and the underlying iterator.
44$filterCallback = function (SplFileInfo $current, $key, RecursiveDirectoryIterator $iterator): bool {
45    // Always accept directories, so we can demonstrate hasChildren() on them.
46    if ($current->isDir()) {
47        return true;
48    }
49    // Only accept files with a '.txt' extension.
50    return $current->isFile() && $current->getExtension() === 'txt';
51};
52
53// --- 4. Create RecursiveCallbackFilterIterator ---
54// This wraps the RecursiveDirectoryIterator and applies our filter callback.
55$filterIterator = new RecursiveCallbackFilterIterator($directoryIterator, $filterCallback);
56
57// --- 5. Helper function to process and display children recursively ---
58/**
59 * Recursively processes a RecursiveIterator and displays its elements,
60 * explicitly checking if each element has children using `hasChildren()`.
61 *
62 * @param RecursiveIterator $iterator The iterator to process.
63 * @param int $depth Current recursion depth for indentation.
64 */
65function processIteratorChildren(RecursiveIterator $iterator, int $depth = 0): void
66{
67    // Iterate through the elements at the current level of the iterator.
68    foreach ($iterator as $name => $currentElement) {
69        $indent = str_repeat('  ', $depth);
70        $typeIcon = $currentElement->isDir() ? '📁 ' : '📄 ';
71        echo $indent . $typeIcon . $currentElement->getBasename();
72
73        // RecursiveCallbackFilterIterator::hasChildren() is called on the iterator itself.
74        // It checks if the *current element* the iterator is pointing to (i.e., $currentElement)
75        // has children. For a directory, this typically returns true; for a file, false.
76        // This is a direct check for the *existence* of child elements.
77        if ($iterator->hasChildren()) {
78            echo " (Has Children: YES)\n";
79            // If the current element has children, get the iterator for its children
80            // and recurse into them.
81            processIteratorChildren($iterator->getChildren(), $depth + 1);
82        } else {
83            echo " (Has Children: NO)\n";
84        }
85    }
86}
87
88// --- 6. Run the recursive processing ---
89processIteratorChildren($filterIterator);
90
91echo "---------------------------------------------------------------------\n";
92
93// --- 7. Cleanup: Remove the temporary directory and its contents ---
94// Use RecursiveIteratorIterator for cleanup to handle nested directories.
95$rii = new RecursiveIteratorIterator(
96    new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
97    RecursiveIteratorIterator::CHILD_FIRST
98);
99foreach ($rii as $file) {
100    // Check if it's a directory (and not a symbolic link if you want to be super cautious)
101    if ($file->isDir()) {
102        rmdir($file->getPathname()); // Remove empty subdirectory
103    } else {
104        unlink($file->getPathname()); // Remove file
105    }
106}
107rmdir($tempDir); // Remove the top-level temporary directory
108
109?>

RecursiveCallbackFilterIterator::hasChildren()は、PHP 8で提供されるメソッドで、イテレータが現在指している要素に子要素が存在するかどうかを確認するために使用されます。このメソッドはRecursiveCallbackFilterIteratorクラスに属しており、ファイルシステムなどの構造を再帰的に走査し、特定の条件でフィルタリングする際に、現在の要素がさらに展開できる（子要素を持つ）かどうかを判定するのに役立ちます。

引数はなく、戻り値は真偽値（bool）です。イテレータが現在指す要素が、さらに下位の要素（ファイルやサブディレクトリなど）を持っている場合にtrueを返し、持っていない場合（例えばファイルや空のディレクトリ）にはfalseを返します。これにより、イテレータがさらに深い階層に進むべきかどうかの判断を効率的に行えます。

サンプルコードでは、一時的なディレクトリ構造を作成し、特定のフィルタ条件（.txtファイルとすべてのディレクトリを許可）を適用したRecursiveCallbackFilterIteratorを用いて走査しています。各要素についてhasChildren()を明示的に呼び出し、子要素の有無を表示することで、このメソッドの具体的な動作を確認できます。特に、ディレクトリが子要素を持つか、持たないかを判断する場面でその役割がよくわかります。