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

Copy
1<?php
2
3/**
4 * RecursiveTreeIterator::getDepth() メソッドの使用例を示します。
5 * 指定されたパスに一時的なディレクトリ構造を作成し、その構造と各要素の深さを表示します。
6 *
7 * @param string $basePath 一時的なディレクトリ構造を作成するベースパス。
8 */
9function demonstrateRecursiveTreeIteratorGetDepth(string $basePath): void
10{
11    // --- サンプル用のディレクトリ構造を一時的に作成 ---
12    // この部分は、getDepth() の動作を示すために必要なファイルシステム環境を準備するものです。
13    // 実際のアプリケーションでは、既存のディレクトリに対して適用します。
14    if (!is_dir($basePath)) {
15        mkdir($basePath, 0777, true);
16    }
17    file_put_contents($basePath . '/file1.txt', 'Content 1');
18    mkdir($basePath . '/subdir1', 0777);
19    file_put_contents($basePath . '/subdir1/file2.txt', 'Content 2');
20    mkdir($basePath . '/subdir1/subdir2', 0777);
21    file_put_contents($basePath . '/subdir1/subdir2/file3.txt', 'Content 3');
22    file_put_contents($basePath . '/file4.txt', 'Content 4');
23    // --- サンプルディレクトリ構造の作成ここまで ---
24
25    echo "ディレクトリ構造と深さ（ベースパス: " . $basePath . "）:\n";
26    echo "----------------------------------------\n";
27
28    try {
29        // RecursiveDirectoryIterator: 指定されたディレクトリを再帰的に走査するイテレータ。
30        // SKIP_DOTSは、'.' (現在のディレクトリ) と '..' (親ディレクトリ) をスキップします。
31        $directoryIterator = new RecursiveDirectoryIterator($basePath, RecursiveDirectoryIterator::SKIP_DOTS);
32
33        // RecursiveIteratorIterator: 再帰的なイテレータをフラットに処理するためのイテレータ。
34        // SELF_FIRSTは、ディレクトリ自体を処理してからその内容を処理します。
35        $recursiveIterator = new RecursiveIteratorIterator($directoryIterator, RecursiveIteratorIterator::SELF_FIRST);
36
37        // RecursiveTreeIterator: 再帰イテレータをツリー構造として扱い、深さを取得するためのイテレータ。
38        $treeIterator = new RecursiveTreeIterator($recursiveIterator);
39
40        // 各要素をループし、その深さと名前を表示
41        foreach ($treeIterator as $name => $fileInfo) {
42            // RecursiveTreeIterator::getDepth() メソッド:
43            // 現在の要素がルートディレクトリからどれくらいの深さにあるか（int）を返します。
44            // ルートディレクトリからの深さが0として始まります。
45            $depth = $treeIterator->getDepth();
46
47            // 深さに応じてインデントを付け、ツリー構造を視覚的に表現
48            echo str_repeat('  ', $depth) . $name . " (深さ: " . $depth . ")\n";
49        }
50
51    } catch (UnexpectedValueException $e) {
52        // ディレクトリが見つからないなどのエラーを捕捉
53        echo "エラー: ディレクトリの読み込み中に問題が発生しました。" . $e->getMessage() . "\n";
54    } finally {
55        // --- サンプルディレクトリ構造のクリーンアップ ---
56        // 作成した一時的なファイルとディレクトリを削除し、環境をきれいにします。
57        if (is_dir($basePath)) {
58            $it = new RecursiveDirectoryIterator($basePath, RecursiveDirectoryIterator::SKIP_DOTS);
59            $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
60            foreach ($files as $file) {
61                if ($file->isDir()) {
62                    rmdir($file->getRealPath());
63                } else {
64                    unlink($file->getRealPath());
65                }
66            }
67            rmdir($basePath);
68        }
69        // --- クリーンアップここまで ---
70    }
71}
72
73// スクリプト実行部: 一時ディレクトリを生成して関数を呼び出す
74// システムの一時ディレクトリパスを利用し、ユニークな名前を付けて衝突を避けます。
75$tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_getdepth_example_' . uniqid();
76demonstrateRecursiveTreeIteratorGetDepth($tempDir);

RecursiveTreeIterator::getDepth()メソッドは、PHPでファイルシステムや再帰的なデータ構造をツリー（木）のように扱いたい場合に、現在処理している要素が基準となる位置からどれくらいの「深さ（階層）」にあるかを取得するために使用します。このメソッドは引数を一切取らず、現在の要素の深さを整数値（int）で返します。深さは0から始まり、例えばルートとなるディレクトリ直下の要素は深さ0、その中のサブディレクトリやファイルは深さ1、さらにその中は深さ2といった形でカウントされます。

サンプルコードでは、まず一時的なディレクトリ構造を作成し、そのディレクトリをRecursiveDirectoryIteratorとRecursiveIteratorIteratorを使って再帰的に走査できる状態にします。その後、この再帰イテレータをRecursiveTreeIteratorに渡すことで、ディレクトリ構造をツリーとして扱えるように準備します。foreachループで各要素を処理する際に、$treeIterator->getDepth()を呼び出すことで、現在アクセスしているファイルやディレクトリが、一番外側のディレクトリ（ベースパス）から見て何階層目にあるのかを数値として取得し、それを画面に表示しています。これにより、複雑な階層構造を持つデータを視覚的に理解しやすくなります。

Copy
1<?php
2
3/**
4 * RecursiveTreeIterator クラスと getDepth() メソッドの使用例を示します。
5 * 多次元配列をツリー構造として走査し、各要素の深さを取得します。
6 *
7 * システムエンジニアを目指す初心者向けに、ツリー構造のデータを扱い、
8 * その階層（深さ）を取得する方法を理解するのに役立ちます。
9 */
10function demonstrateRecursiveTreeIteratorDepth(): void
11{
12    // ツリー構造を模した多次元配列を準備します。
13    // ここでは、ファイルシステムのような階層構造を表現しています。
14    // キーはフォルダ名またはファイル名のないインデックス、値はサブ要素またはファイル名です。
15    $treeData = [
16        'documents' => [ // 0階層目: 'documents' フォルダ
17            'report.docx', // 1階層目: 'report.docx' ファイル
18            'archives' => [ // 1階層目: 'archives' フォルダ
19                'old_data.zip', // 2階層目: 'old_data.zip' ファイル
20                'projects' => [ // 2階層目: 'projects' フォルダ
21                    'projectA_spec.pdf', // 3階層目: 'projectA_spec.pdf' ファイル
22                    'projectB_plan.xlsx' // 3階層目: 'projectB_plan.xlsx' ファイル
23                ]
24            ],
25            'notes.txt' // 1階層目: 'notes.txt' ファイル
26        ],
27        'images' => [ // 0階層目: 'images' フォルダ
28            'photo1.jpg', // 1階層目: 'photo1.jpg' ファイル
29            'vacation' => [ // 1階層目: 'vacation' フォルダ
30                'beach.png' // 2階層目: 'beach.png' ファイル
31            ]
32        ],
33        'README.md' // 0階層目: 'README.md' ファイル
34    ];
35
36    echo "=== ツリー構造の要素と深さのデモンストレーション ===\n\n";
37
38    // 1. RecursiveArrayIterator を使用して、配列を再帰イテレータに変換します。
39    //    これにより、ネストされた配列もイテレータとして扱えるようになります。
40    $recursiveIterator = new RecursiveArrayIterator($treeData);
41
42    // 2. RecursiveTreeIterator を使用して、RecursiveArrayIterator をツリー形式で
43    //    走査し、getDepth() メソッドが利用できるようにラップします。
44    //    このイテレータがツリーの各レベルを認識し、深さ情報を提供します。
45    $treeIterator = new RecursiveTreeIterator($recursiveIterator);
46
47    // 3. foreach ループでツリー構造を走査し、各要素の深さを取得・表示します。
48    //    getDepth() は現在の要素のツリー内の深さを返します (ルートは0)。
49    foreach ($treeIterator as $key => $value) {
50        // getDepth() メソッドは、現在の要素がツリー内でどれだけ深い階層にあるか (0から始まる) を整数で返します。
51        $depth = $treeIterator->getDepth();
52
53        // 深さに応じてスペースでインデントを追加し、ツリー構造を見やすくします。
54        echo str_repeat('  ', $depth);
55
56        // 要素の種類 (フォルダまたはファイル) とその名前、および深さを表示します。
57        // $value が配列であれば、それはフォルダ (中間ノード) を意味します。
58        // $value が配列でなければ、それはファイル (葉ノード) を意味します。
59        if (is_array($value)) {
60            // フォルダの場合、キーがフォルダ名となります。
61            echo "- [Folder] " . $key . " (Depth: " . $depth . ")\n";
62        } else {
63            // ファイルの場合、値がファイル名となります。
64            echo "- [File] " . $value . " (Depth: " . $depth . ")\n";
65        }
66    }
67
68    echo "\n=== デモンストレーション終了 ===\n";
69}
70
71// 関数を実行してデモンストレーションを開始します。
72demonstrateRecursiveTreeIteratorDepth();

このPHPサンプルコードは、RecursiveTreeIteratorクラスが提供するgetDepth()メソッドを利用して、多次元配列で表現されたツリー構造データの各要素がどの階層（深さ）にあるかを調べる方法を示しています。

まず、ファイルシステムのような階層構造を模した多次元配列$treeDataを準備します。この配列は、RecursiveArrayIteratorによって再帰的に処理可能なイテレータに変換され、さらにRecursiveTreeIteratorによってツリー構造として走査できるようラップされます。

foreachループを用いてツリーの各要素を順番に処理する際、$treeIterator->getDepth()を呼び出すことで、現在の要素がツリーのルート（一番上の階層）から何階層下にあるかを整数値で取得できます。このgetDepth()メソッドは引数を一切必要とせず、現在の深さを表すint型の値を返します。取得した深さ情報を使って、出力される要素には適切なインデントが付けられ、ツリーの視覚的な階層が分かりやすく表示されます。このコードは、ツリー構造のデータを効率的に扱い、その階層情報をプログラムで取得する方法を理解するのに役立ちます。