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

Copy
1<?php
2
3/**
4 * テスト用のディレクトリ構造を一時的に作成します。
5 *
6 * @param string $basePath 作成するディレクトリのルートパス
7 */
8function createTestDirectoryStructure(string $basePath): void
9{
10    // ベースディレクトリが存在しない場合は作成します
11    if (!is_dir($basePath)) {
12        mkdir($basePath, 0777, true);
13    }
14
15    // ファイルとサブディレクトリを作成します
16    file_put_contents($basePath . '/file1.txt', 'Content of file1'); // 深さ0
17    mkdir($basePath . '/subdir1', 0777, true);
18    file_put_contents($basePath . '/subdir1/file2.txt', 'Content of file2'); // 深さ1
19    mkdir($basePath . '/subdir1/subdir2', 0777, true);
20    file_put_contents($basePath . '/subdir1/subdir2/file3.txt', 'Content of file3'); // 深さ2
21    mkdir($basePath . '/subdir3', 0777, true);
22    file_put_contents($basePath . '/subdir3/file4.txt', 'Content of file4'); // 深さ1
23}
24
25/**
26 * テスト用ディレクトリとファイルをクリーンアップ（削除）します。
27 *
28 * @param string $basePath クリーンアップするディレクトリのルートパス
29 */
30function cleanupTestDirectory(string $basePath): void
31{
32    if (is_dir($basePath)) {
33        // RecursiveIteratorIterator を使用してディレクトリ内のすべてのファイルを削除
34        // CHILD_FIRST モードは、子要素を先に削除してから親ディレクトリを削除します
35        $files = new RecursiveIteratorIterator(
36            new RecursiveDirectoryIterator($basePath, RecursiveDirectoryIterator::SKIP_DOTS),
37            RecursiveIteratorIterator::CHILD_FIRST
38        );
39        foreach ($files as $fileinfo) {
40            if ($fileinfo->isDir()) {
41                rmdir($fileinfo->getRealPath()); // ディレクトリを削除
42            } else {
43                unlink($fileinfo->getRealPath()); // ファイルを削除
44            }
45        }
46        rmdir($basePath); // ベースディレクトリを削除
47    }
48}
49
50/**
51 * RecursiveIteratorIterator::setMaxDepth() メソッドの使用例を示します。
52 * このメソッドは、再帰的なイテレーションの最大深度を設定します。
53 */
54function demonstrateRecursiveIteratorIteratorSetMaxDepth(): void
55{
56    // 一時的なテストディレクトリパスを生成
57    $testDirPath = sys_get_temp_dir() . '/recursive_iterator_test_' . uniqid();
58
59    // テスト用のディレクトリ構造を作成
60    createTestDirectoryStructure($testDirPath);
61
62    echo "--- テストディレクトリの構造 ---\n";
63    echo "ベースパス: " . $testDirPath . "\n";
64    echo "|- file1.txt (深さ0)\n";
65    echo "|- subdir1/\n";
66    echo "|  |- file2.txt (深さ1)\n";
67    echo "|  `- subdir2/\n";
68    echo "|     `- file3.txt (深さ2)\n";
69    echo "`- subdir3/\n";
70    echo "   `- file4.txt (深さ1)\n\n";
71
72    // 最初に RecursiveDirectoryIterator を作成
73    // SKIP_DOTS は "." と ".." ディレクトリをスキップします
74    $directoryIterator = new RecursiveDirectoryIterator(
75        $testDirPath,
76        RecursiveDirectoryIterator::SKIP_DOTS
77    );
78
79    // 次に RecursiveIteratorIterator を作成
80    // LEAVES_ONLY はファイル（葉）のみをイテレートし、ディレクトリはスキップします
81    $iterator = new RecursiveIteratorIterator(
82        $directoryIterator,
83        RecursiveIteratorIterator::LEAVES_ONLY
84    );
85
86    // --- setMaxDepth を使用しない場合（デフォルトは -1、つまりすべての深さ） ---
87    echo "--- setMaxDepth を設定しない場合（デフォルトは無限、全階層）---\n";
88    // setMaxDepth のデフォルト値は -1 で、再帰の深さに制限はありません
89    // デフォルトの動作を確認するため、明示的に -1 を設定しても良い
90    $iterator->setMaxDepth(-1); 
91    foreach ($iterator as $fileInfo) {
92        echo $fileInfo->getPathname() . "\n";
93    }
94    echo "\n";
95
96    // --- setMaxDepth を 0 に設定した場合（現在のディレクトリのファイルのみ） ---
97    echo "--- setMaxDepth を 0 に設定した場合（現在の階層のみ）---\n";
98    // 深さ 0 は、ベースディレクトリ直下の要素のみを意味します
99    $iterator->setMaxDepth(0);
100    foreach ($iterator as $fileInfo) {
101        echo $fileInfo->getPathname() . "\n";
102    }
103    echo "\n";
104
105    // --- setMaxDepth を 1 に設定した場合（現在のディレクトリと一つ下の階層まで） ---
106    echo "--- setMaxDepth を 1 に設定した場合（現在の階層と一つ下の階層まで）---\n";
107    // 深さ 1 は、ベースディレクトリ直下とその一つ下の階層の要素までを意味します
108    $iterator->setMaxDepth(1);
109    foreach ($iterator as $fileInfo) {
110        echo $fileInfo->getPathname() . "\n";
111    }
112    echo "\n";
113
114    // --- setMaxDepth を 2 に設定した場合（現在のディレクトリと二つ下の階層まで） ---
115    echo "--- setMaxDepth を 2 に設定した場合（現在の階層と二つ下の階層まで）---\n";
116    // 深さ 2 は、ベースディレクトリ直下とその二つ下の階層の要素までを意味します
117    $iterator->setMaxDepth(2);
118    foreach ($iterator as $fileInfo) {
119        echo $fileInfo->getPathname() . "\n";
120    }
121    echo "\n";
122
123    // テスト用ディレクトリをクリーンアップ
124    cleanupTestDirectory($testDirPath);
125    echo "--- テストディレクトリのクリーンアップが完了しました ---\n";
126}
127
128// サンプルコードを実行
129demonstrateRecursiveIteratorIteratorSetMaxDepth();

PHPのRecursiveIteratorIteratorは、ディレクトリのような階層構造を効率的に処理する際に利用されるクラスです。その中でsetMaxDepthメソッドは、再帰的にファイルやディレクトリを探索する際の「深さ」、つまり何階層下までを対象とするかを制限するために使われます。

このメソッドは$maxDepthという整数の引数を一つ受け取ります。この引数で、探索する階層の最大値を設定します。デフォルト値の-1を設定した場合、深さの制限はなく、すべての階層を探索します。0を設定すると、イテレータが開始されたディレクトリ（最上階層）直下の要素のみを対象とし、サブディレクトリには降りていきません。1を設定すると、最上階層とその一つ下のサブディレクトリまでの要素が対象となります。この値を大きくするほど、より深い階層まで探索範囲が広がります。このメソッドは戻り値を返さず、イテレータの内部設定を変更するだけです。

サンプルコードでは、まず一時的なディレクトリ構造を作成し、その構造に対してsetMaxDepthの引数を-1（デフォルト）、0、1、2と変更した場合に、それぞれの設定でどの深さまでのファイルがイテレートされるのかを具体的に示しています。これにより、setMaxDepthがファイルの探索範囲にどのような影響を与えるかを明確に確認できます。

Copy
1<?php
2
3(function () {
4    // テスト用のベースディレクトリを定義します。
5    // スクリプトが実行されるディレクトリに一時的なフォルダが作成されます。
6    $testDir = __DIR__ . '/test_recursive_iterator';
7
8    /**
9     * テスト用のディレクトリ構造を作成するヘルパー関数です。
10     * 既存の同じ名前の構造があれば削除し、新しい構造を作成します。
11     *
12     * @param string $basePath テストディレクトリのパス。
13     */
14    $createTestDirectoryStructure = function (string $basePath): void {
15        // 既存のテストディレクトリがあれば、まずクリーンアップします。
16        if (is_dir($basePath)) {
17            $it = new RecursiveDirectoryIterator($basePath, RecursiveDirectoryIterator::SKIP_DOTS);
18            $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
19            foreach ($files as $file) {
20                if ($file->isDir()) {
21                    rmdir($file->getRealPath()); // ディレクトリを削除
22                } else {
23                    unlink($file->getRealPath()); // ファイルを削除
24                }
25            }
26            rmdir($basePath); // ベースディレクトリを削除
27        }
28        // 新しいテストディレクトリ構造を作成します。
29        mkdir($basePath, 0777, true); // 再帰的にディレクトリを作成 (0777は開発環境向け)
30
31        // 階層0（ベースディレクトリ直下）の要素
32        // dir1 は RecursiveIteratorIterator では深さ0の要素として扱われます。
33        mkdir($basePath . '/dir1');
34        // file1_depth1.txt は RecursiveIteratorIterator では深さ0の要素として扱われます。
35        file_put_contents($basePath . '/dir1/file1_depth0.txt', 'Content 1');
36        
37        // 階層1の要素
38        // subdir1 は RecursiveIteratorIterator では深さ1の要素として扱われます。
39        mkdir($basePath . '/dir1/subdir1');
40        // file2_depth1.txt は RecursiveIteratorIterator では深さ1の要素として扱われます。
41        file_put_contents($basePath . '/dir1/subdir1/file2_depth1.txt', 'Content 2');
42        
43        // 階層2の要素
44        // subsubdir1 は RecursiveIteratorIterator では深さ2の要素として扱われます。
45        mkdir($basePath . '/dir1/subdir1/subsubdir1');
46        // file3_depth2.txt は RecursiveIteratorIterator では深さ2の要素として扱われます。
47        file_put_contents($basePath . '/dir1/subdir1/subsubdir1/file3_depth2.txt', 'Content 3');
48
49        // 別の階層0の要素
50        // dir2 は RecursiveIteratorIterator では深さ0の要素として扱われます。
51        mkdir($basePath . '/dir2');
52        // file4_depth0.txt は RecursiveIteratorIterator では深さ0の要素として扱われます。
53        file_put_contents($basePath . '/dir2/file4_depth0.txt', 'Content 4');
54    };
55
56    /**
57     * テスト用のディレクトリ構造をクリーンアップするヘルパー関数です。
58     *
59     * @param string $basePath クリーンアップするディレクトリのパス。
60     */
61    $cleanUpTestDirectoryStructure = function (string $basePath): void {
62        if (is_dir($basePath)) {
63            $it = new RecursiveDirectoryIterator($basePath, RecursiveDirectoryIterator::SKIP_DOTS);
64            $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
65            foreach ($files as $file) {
66                if ($file->isDir()) {
67                    rmdir($file->getRealPath());
68                } else {
69                    unlink($file->getRealPath());
70                }
71            }
72            rmdir($basePath);
73            echo "\nテストディレクトリ '{$basePath}' をクリーンアップしました。\n";
74        }
75    };
76
77    // テストディレクトリ構造の作成を実行します。
78    $createTestDirectoryStructure($testDir);
79
80    echo "--- RecursiveIteratorIterator::setMaxDepth() を使用しない場合 (デフォルト: 無限深度) ---\n";
81    try {
82        // RecursiveDirectoryIterator で指定されたディレクトリを反復処理します。
83        // SKIP_DOTS フラグは "." と ".." ディレクトリをスキップします。
84        $iterator = new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS);
85        
86        // RecursiveIteratorIterator で再帰的に反復処理できるようにラップします。
87        $recursiveIterator = new RecursiveIteratorIterator($iterator);
88        // setMaxDepth() を呼び出さない場合、デフォルトの深度は -1 (無限深度) です。
89
90        foreach ($recursiveIterator as $fileInfo) {
91            // RecursiveIteratorIterator::getDepth() で現在の要素の深さを取得します。
92            // ベースディレクトリ直下の要素は深さ0、その中の要素は深さ1、と続きます。
93            echo sprintf(
94                "Depth %d: %s (Type: %s)\n",
95                $recursiveIterator->getDepth(),
96                $fileInfo->getFilename(),
97                $fileInfo->getType()
98            );
99        }
100    } catch (UnexpectedValueException $e) {
101        echo "エラー: " . $e->getMessage() . "\n";
102    }
103
104    echo "\n--- RecursiveIteratorIterator::setMaxDepth(1) を使用した場合 (深さ1まで) ---\n";
105    try {
106        $iterator = new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS);
107        $recursiveIterator = new RecursiveIteratorIterator($iterator);
108        
109        // setMaxDepth(1) を呼び出すことで、処理する最大深度を1に設定します。
110        // これは、getDepth() が 0 または 1 の要素のみが処理されることを意味します。
111        $recursiveIterator->setMaxDepth(1); 
112
113        foreach ($recursiveIterator as $fileInfo) {
114            echo sprintf(
115                "Depth %d: %s (Type: %s)\n",
116                $recursiveIterator->getDepth(),
117                $fileInfo->getFilename(),
118                $fileInfo->getType()
119            );
120        }
121    } catch (UnexpectedValueException $e) {
122        echo "エラー: " . $e->getMessage() . "\n";
123    }
124
125    // テストディレクトリ構造のクリーンアップを実行します。
126    $cleanUpTestDirectoryStructure($testDir);
127})();

RecursiveIteratorIterator::setMaxDepth()は、PHPでファイルシステムや多次元配列といった再帰的なデータ構造を効率的に走査する際、処理する最大の深さを設定するメソッドです。このメソッドを使用することで、特定の階層までで処理を止め、それより深い階層へのアクセスを制限できます。

引数$maxDepthには、整数で深さのレベルを指定します。0を指定すると、イテレータが最初に扱う要素の直下のみを処理対象とし、それより深い階層には進みません。1を指定すると、深さ0の要素とその次の階層（深さ1）までの要素が処理されます。デフォルト値である-1を指定するか、このメソッドを呼び出さない場合は、深さの制限なくすべての階層が走査されます。このメソッドはイテレータの動作を設定するものであり、戻り値はありません。

提供されたサンプルコードでは、まず一時的なディレクトリ構造を作成し、RecursiveIteratorIteratorを使ってその中身を反復処理しています。setMaxDepth()を呼び出さない場合の出力は、すべてのファイルとディレクトリがそれぞれの深さとともに表示されます。次にsetMaxDepth(1)を呼び出して再度走査する例では、深さ1までの要素のみが表示され、それより深い階層の要素はスキップされることで、設定した最大深度がどのように適用されるかが具体的に示されています。