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

Copy
1<?php
2
3/**
4 * RecursiveIteratorIterator::getMaxDepth() の使用例。
5 *
6 * この関数は、指定されたディレクトリ構造を再帰的に走査するイテレータの
7 * 設定された最大深度を取得する方法を示します。
8 *
9 * PHP 8 環境で動作するように設計されており、システムの安全な一時ディレクトリに
10 * テスト用のファイルとディレクトリを作成・削除します。
11 */
12function demonstrateMaxDepth(): void
13{
14    // 一時的なディレクトリとファイルを生成し、再帰的な構造をシミュレートします。
15    // これにより、サンプルコードが単体で動作し、任意の環境で試すことができます。
16    $baseDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'test_recursive_dir_' . uniqid();
17    mkdir($baseDir);
18    mkdir($baseDir . DIRECTORY_SEPARATOR . 'dir1');
19    mkdir($baseDir . DIRECTORY_SEPARATOR . 'dir1' . DIRECTORY_SEPARATOR . 'dir2');
20    file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'file0.txt', 'Content at depth 0');
21    file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'dir1' . DIRECTORY_SEPARATOR . 'file1.txt', 'Content at depth 1');
22    file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'dir1' . DIRECTORY_SEPARATOR . 'dir2' . DIRECTORY_SEPARATOR . 'file2.txt', 'Content at depth 2');
23
24    echo "--- RecursiveIteratorIterator::getMaxDepth() の使用例 ---\n\n";
25    echo "テストディレクトリ: " . $baseDir . "\n\n";
26
27    // 1. RecursiveDirectoryIterator を作成します。
28    // これは指定されたディレクトリとその中の項目をイテレーションするための基本となるイテレータです。
29    $directoryIterator = new RecursiveDirectoryIterator($baseDir, FilesystemIterator::SKIP_DOTS);
30
31    // 2. RecursiveIteratorIterator でラップします。
32    // RecursiveIteratorIterator は、RecursiveDirectoryIterator のような再帰的なイテレータを
33    // 平坦化して通常のイテレータのように扱えるようにします。
34    // デフォルトでは最大深度は -1 (RecursiveIteratorIterator::UNLIMITED_DEPTH) で、これは無限の深さを意味します。
35    $iterator = new RecursiveIteratorIterator($directoryIterator);
36
37    // 3. デフォルトの最大深度を取得して表示します。
38    // getMaxDepth() は、イテレータに設定されている最大深度を返します。
39    // デフォルト値である -1 は、深度の制限がないことを示します。
40    echo "デフォルトの最大深度: " . $iterator->getMaxDepth() . " (RecursiveIteratorIterator::UNLIMITED_DEPTH)\n\n";
41
42    // 4. 最大深度を 1 に設定し直します。
43    // setMaxDepth() を使用して、イテレータが走査する最大深度を制限できます。
44    // 深度1は、ベースディレクトリ直下のファイルやディレクトリまでを意味します。
45    $iterator->setMaxDepth(1);
46    echo "最大深度を 1 に設定しました。\n";
47
48    // 5. 設定後の最大深度を getMaxDepth() で取得して表示します。
49    $currentMaxDepth = $iterator->getMaxDepth();
50    echo "設定された最大深度: " . $currentMaxDepth . "\n\n";
51
52    // 設定された最大深度 (1) で実際にイテレーションを行い、その効果を確認します。
53    // getDepth() メソッドは、現在の要素がルートからどれだけの深さにあるかを示します。
54    echo "設定された最大深度 (" . $currentMaxDepth . ") でのファイル一覧:\n";
55    foreach ($iterator as $path => $fileInfo) {
56        $currentDepth = $iterator->getDepth(); // 現在のイテレーションの深度を取得
57        echo str_repeat('  ', $currentDepth) . "- [Depth: {$currentDepth}] " . $fileInfo->getFilename() . "\n";
58    }
59    echo "\n";
60
61    // 6. 最大深度を 0 に設定し直します。
62    // 深度0は、ベースディレクトリ直下のファイルのみを意味し、サブディレクトリは走査されません。
63    $iterator->setMaxDepth(0);
64    echo "最大深度を 0 に設定しました。\n";
65    $currentMaxDepth = $iterator->getMaxDepth();
66    echo "設定された最大深度: " . $currentMaxDepth . "\n\n";
67
68    echo "設定された最大深度 (" . $currentMaxDepth . ") でのファイル一覧:\n";
69    foreach ($iterator as $path => $fileInfo) {
70        $currentDepth = $iterator->getDepth();
71        echo str_repeat('  ', $currentDepth) . "- [Depth: {$currentDepth}] " . $fileInfo->getFilename() . "\n";
72    }
73    echo "\n";
74
75    // 作成した一時ファイルとディレクトリをクリーンアップします。
76    // CHILD_FIRST フラグにより、子要素が先に削除され、その後親ディレクトリが削除されます。
77    $cleanUpIterator = new RecursiveIteratorIterator(
78        new RecursiveDirectoryIterator($baseDir, FilesystemIterator::SKIP_DOTS),
79        RecursiveIteratorIterator::CHILD_FIRST
80    );
81    foreach ($cleanUpIterator as $path) {
82        if ($path->isFile()) {
83            unlink($path->getPathname());
84        } elseif ($path->isDir()) {
85            rmdir($path->getPathname());
86        }
87    }
88    rmdir($baseDir); // 最上位のベースディレクトリを削除
89    echo "一時ディレクトリ '{$baseDir}' をクリーンアップしました。\n";
90}
91
92// サンプルコードの関数を実行します。
93demonstrateMaxDepth();

RecursiveIteratorIterator::getMaxDepth()は、PHPのRecursiveIteratorIteratorクラスに属するメソッドで、再帰的にファイルシステムなどを走査する際の最大深度の制限値を取得します。このメソッドは引数を一切取りません。

RecursiveIteratorIteratorは、ディレクトリ構造のように階層を持つデータに対して、深さ方向へのイテレーション（繰り返し処理）を行うためのクラスです。getMaxDepth()は、そのRecursiveIteratorIteratorインスタンスに対して、どこまでの深さまでを走査対象とするか設定されている現在の最大深度を整数値（int）で返します。

戻り値の-1は、深度に制限がない、つまり全ての階層を走査することを示します。例えば、setMaxDepth(1)で最大深度を1に設定した場合、getMaxDepth()は1を返します。これは、基点となるディレクトリの直下（深度0）と、その下の階層（深度1）までを対象とするという意味です。深度0に設定した場合は、基点ディレクトリ直下の要素のみを走査対象とします。

このメソッドは、現在設定されているイテレーションの深さ制限を確認するために使用され、setMaxDepth()と組み合わせて、再帰的な処理の範囲を動的に制御する際に役立ちます。サンプルコードでは、一時ディレクトリを作成し、デフォルトの最大深度や、setMaxDepth()で変更した後の最大深度をgetMaxDepth()で取得し、実際にイテレーションがどのように変化するかを示しています。

Copy
1<?php
2
3/**
4 * RecursiveIteratorIterator::getMaxDepth() の使用例
5 *
6 * このスクリプトは、RecursiveIteratorIterator を用いて
7 * 再帰的なディレクトリ構造を走査し、設定された最大深度を
8 * 取得する方法を示します。
9 *
10 * @see https://www.php.net/manual/ja/recursiveiteratoriterator.getmaxdepth.php
11 */
12
13/**
14 * サンプル用のディレクトリ構造を作成するヘルパー関数。
15 * 既に存在する場合は一度削除して再作成します。
16 *
17 * @param string $baseDir 作成するディレクトリのルートパス
18 */
19function createTempDirectoryStructure(string $baseDir): void
20{
21    if (file_exists($baseDir)) {
22        $files = new RecursiveIteratorIterator(
23            new RecursiveDirectoryIterator($baseDir, FilesystemIterator::SKIP_DOTS),
24            RecursiveIteratorIterator::CHILD_FIRST
25        );
26        foreach ($files as $fileinfo) {
27            if ($fileinfo->isDir()) {
28                rmdir($fileinfo->getRealPath());
29            } else {
30                unlink($fileinfo->getRealPath());
31            }
32        }
33        rmdir($baseDir);
34    }
35
36    mkdir($baseDir, 0777, true);
37    mkdir($baseDir . '/level1');
38    file_put_contents($baseDir . '/level1/file1.txt', 'Content for file1');
39    mkdir($baseDir . '/level1/level2');
40    file_put_contents($baseDir . '/level1/level2/file2.txt', 'Content for file2');
41    mkdir($baseDir . '/level1/level2/level3');
42    file_put_contents($baseDir . '/level1/level2/level3/file3.txt', 'Content for file3');
43    file_put_contents($baseDir . '/root_file.txt', 'Content for root_file');
44
45    echo "一時ディレクトリ構造を作成しました:\n";
46    echo $baseDir . "\n";
47    echo "└── root_file.txt\n";
48    echo "└── level1/\n";
49    echo "    └── file1.txt\n";
50    echo "    └── level2/\n";
51    echo "        └── file2.txt\n";
52    echo "        └── level3/\n";
53    echo "            └── file3.txt\n\n";
54}
55
56// 一時ディレクトリのパスを定義
57$tempDir = __DIR__ . '/temp_recursive_data_example';
58
59// サンプル用のディレクトリ構造を作成
60createTempDirectoryStructure($tempDir);
61
62try {
63    // RecursiveDirectoryIterator を作成し、一時ディレクトリを指す
64    // FilesystemIterator::SKIP_DOTS を使用して '.' と '..' をスキップ
65    $directoryIterator = new RecursiveDirectoryIterator(
66        $tempDir,
67        FilesystemIterator::SKIP_DOTS
68    );
69
70    // RecursiveIteratorIterator を作成
71    // これにより、RecursiveDirectoryIterator が提供する再帰的な情報を利用してイテレートできる
72    $iterator = new RecursiveIteratorIterator($directoryIterator);
73
74    echo "-------------------------------------------\n";
75    echo "RecursiveIteratorIterator::getMaxDepth() の使用例\n";
76    echo "-------------------------------------------\n";
77
78    // 1. 初期状態での最大深度を取得
79    // setMaxDepth() を呼び出していない場合、デフォルトで -1 (深度制限なし) を返す
80    echo "1. 初期状態の最大深度: " . $iterator->getMaxDepth() . " (深度制限なし)\n\n";
81
82    // 2. 最大深度を 1 に設定
83    // これにより、ルートディレクトリの直下（深度0および深度1）までしか走査されなくなる
84    // 例: level1/ は含まれるが level1/level2/ は含まれない
85    $iterator->setMaxDepth(1);
86    echo "2. setMaxDepth(1) 設定後の最大深度: " . $iterator->getMaxDepth() . "\n";
87
88    echo "   >> 最大深度 1 でのディレクトリ内容:\n";
89    foreach ($iterator as $name => $fileInfo) {
90        // SplFileInfo オブジェクトからファイル名と現在のイテレーション深度を取得
91        echo sprintf(
92            "     - %s (深度: %d)\n",
93            $fileInfo->getFilename(),
94            $iterator->getDepth()
95        );
96    }
97    echo "\n";
98
99    // 3. 新しい RecursiveIteratorIterator を作成し、最大深度を 2 に設定
100    // (setMaxDepth() は既存のイテレータの状態を変更するため、新しい設定で再度走査するには
101    // 通常は新しいイテレータインスタンスを作成するか、既存のイテレータをリセットします。)
102    $directoryIteratorForDepth2 = new RecursiveDirectoryIterator(
103        $tempDir,
104        FilesystemIterator::SKIP_DOTS
105    );
106    $iteratorWithDepth2 = new RecursiveIteratorIterator($directoryIteratorForDepth2);
107    $iteratorWithDepth2->setMaxDepth(2);
108    echo "3. setMaxDepth(2) 設定後の最大深度: " . $iteratorWithDepth2->getMaxDepth() . "\n";
109
110    echo "   >> 最大深度 2 でのディレクトリ内容:\n";
111    foreach ($iteratorWithDepth2 as $name => $fileInfo) {
112        echo sprintf(
113            "     - %s (深度: %d)\n",
114            $fileInfo->getFilename(),
115            $iteratorWithDepth2->getDepth()
116        );
117    }
118    echo "\n";
119
120} catch (Exception $e) {
121    echo "エラーが発生しました: " . $e->getMessage() . "\n";
122} finally {
123    // サンプル実行後、作成した一時ディレクトリをクリーンアップ
124    if (file_exists($tempDir)) {
125        $files = new RecursiveIteratorIterator(
126            new RecursiveDirectoryIterator($tempDir, FilesystemIterator::SKIP_DOTS),
127            RecursiveIteratorIterator::CHILD_FIRST
128        );
129        foreach ($files as $fileinfo) {
130            if ($fileinfo->isDir()) {
131                rmdir($fileinfo->getRealPath());
132            } else {
133                unlink($fileinfo->getRealPath());
134            }
135        }
136        rmdir($tempDir);
137        echo "-------------------------------------------\n";
138        echo "一時ディレクトリ '{$tempDir}' をクリーンアップしました。\n";
139        echo "-------------------------------------------\n";
140    }
141}
142

PHPのRecursiveIteratorIterator::getMaxDepth()は、再帰的なデータ構造、例えば入れ子になったディレクトリなどを効率的に走査する際に、現在設定されている最大の「深さ」を取得するためのメソッドです。このメソッドは引数を一切取らず、現在の最大深度を示す整数値（int）を返します。

RecursiveIteratorIteratorクラスは、RecursiveDirectoryIteratorのような再帰的なイテレータと組み合わせて使用され、ファイルシステムなどを指定した深度まで巡回するのに役立ちます。getMaxDepth()は、この巡回がどれだけ深い階層まで行われるかを設定するsetMaxDepth()メソッドと対になるものです。

通常、setMaxDepth()が一度も呼ばれていない場合、getMaxDepth()はデフォルト値として-1を返します。これは、深度に制限がなく、可能な限り深い階層まで走査するという意味です。setMaxDepth()で特定の深度（例えば1や2など）を設定すると、getMaxDepth()はその設定された値を返します。これにより、ファイルやディレクトリの走査を特定の階層までで制御することができます。

サンプルコードでは、setMaxDepth()を呼び出す前のデフォルトの最大深度が-1であることを確認し、その後setMaxDepth(1)やsetMaxDepth(2)で最大深度を設定した場合に、getMaxDepth()が正しく設定値を返すことを示しています。このように、getMaxDepth()は再帰的な走査の範囲をプログラムで確認するために利用されます。