【PHP8.x】RecursiveTreeIterator::PREFIX_LEFT定数の使い方

Copy
1<?php
2
3/**
4 * PHPのRecursiveTreeIteratorとRecursiveTreeIterator::PREFIX_LEFT定数の使用例を示します。
5 * この関数は、多次元配列（ツリー構造）を読みやすい形式で表示する方法を説明します。
6 * RecursiveTreeIterator::PREFIX_LEFT は、ツリー構造の各要素の前に表示される接頭辞（例: ├──, │   ）を
7 * 適切に生成するために使用されるフラグです。これにより、伝統的なツリー表示が可能になります。
8 */
9function demonstrateRecursiveTreeIteratorWithPrefix(): void
10{
11    // ツリー構造を模倣した多次元配列を準備します。
12    // この配列は、ファイルシステムや組織図のような階層構造を表します。
13    $treeData = [
14        'Root Folder' => [
15            'Sub Folder A' => [
16                'File A1.txt',
17                'File A2.txt',
18                'Sub-Sub Folder AA' => [
19                    'File AA1.txt'
20                ]
21            ],
22            'Sub Folder B' => [
23                'File B1.txt',
24                'File B2.txt'
25            ],
26            'Top Level File.txt'
27        ]
28    ];
29
30    echo "--- RecursiveTreeIterator::PREFIX_LEFT を使用したツリー表示 ---\n";
31
32    // 1. RecursiveArrayIterator:
33    //    多次元配列を再帰的にイテレート可能なオブジェクトに変換します。
34    $arrayIterator = new RecursiveArrayIterator($treeData);
35
36    // 2. RecursiveTreeIterator:
37    //    RecursiveArrayIterator を元に、ツリー構造を整形して出力するためのイテレータを作成します。
38    //    コンストラクタの第2引数でフラグを指定します。
39    //
40    //    - RecursiveTreeIterator::BYPASS_KEY:
41    //      各ノードのキー（配列のインデックスや連想キー）が、
42    //      RecursiveTreeIterator::getPrefix() が生成するプレフィックス文字列に含めないようにします。
43    //      これにより、値のみがプレフィックスの後ろに表示されます。
44    //
45    //    - RecursiveTreeIterator::PREFIX_LEFT:
46    //      この定数が最も重要です。ツリーの接頭辞（例: '├── ', '│   ', '└── '）を適切に生成し、
47    //      各要素の左側に表示されるように制御します。
48    //      これにより、視覚的に整った伝統的なツリー構造が出力されます。
49    //
50    //    第3引数 RecursiveIteratorIterator::SELF_FIRST は、
51    //    親ノード（例: 'Root Folder'）を子ノード（例: 'Sub Folder A'）より先に処理することを指定します。
52    $treeIterator = new RecursiveTreeIterator(
53        $arrayIterator,
54        RecursiveTreeIterator::BYPASS_KEY | RecursiveTreeIterator::PREFIX_LEFT,
55        RecursiveIteratorIterator::SELF_FIRST
56    );
57
58    // 3. RecursiveIteratorIterator:
59    //    RecursiveTreeIterator の全ての要素を反復処理し、整形されたツリー構造を出力します。
60    //    RecursiveTreeIteratorIterator は、再帰的なイテレータを平坦化し、全ての要素をループ可能にします。
61    foreach (new RecursiveIteratorIterator($treeIterator, RecursiveIteratorIterator::SELF_FIRST) as $item) {
62        // RecursiveTreeIterator::getPrefix() メソッドは、現在の要素の深さに応じた
63        // ツリーの接続線やインデントを表現する文字列（例: "├── ", "│   "）を返します。
64        // これを $item (現在の要素の値) の前に結合して表示することで、ツリー構造を表現します。
65        echo $treeIterator->getPrefix() . $item . "\n";
66    }
67}
68
69// 上で定義した関数を実行し、ツリー表示を出力します。
70demonstrateRecursiveTreeIteratorWithPrefix();
71

PHP 8のRecursiveTreeIterator::PREFIX_LEFTは、RecursiveTreeIteratorクラスに属する定数です。この定数は引数を取らず、特別な戻り値もありません。

RecursiveTreeIteratorは、多次元配列のような再帰的なデータ構造（ツリー構造）を、視覚的に分かりやすい形式で繰り返し処理するためのクラスです。PREFIX_LEFT定数は、このRecursiveTreeIteratorのコンストラクタにフラグとして渡すことで使用します。その主な役割は、ツリー構造の各要素の前に、伝統的なツリー表示で用いられる接頭辞（例えば「├── 」や「│ 」といった接続線やインデント）を生成し、左側に配置するよう制御することです。

これにより、ファイルシステムや組織図のような階層的なデータを、インデントと接続線を使って構造を表現した、視覚的に整ったツリー形式で出力することが可能になります。サンプルコードでは、多次元配列をRecursiveArrayIteratorで再帰可能なオブジェクトに変換し、RecursiveTreeIteratorとPREFIX_LEFT定数を組み合わせて、整形されたツリー表示を実現しています。RecursiveTreeIterator::getPrefix()メソッドによって生成される接頭辞と各要素の値を結合して表示することで、データの階層関係が明確に示されます。システムエンジニアを目指す初心者の方にとって、複雑な階層データを整理して表示する際に非常に役立つ定数です。

Copy
1<?php
2
3/**
4 * RecursiveTreeIterator と RecursiveTreeIterator::PREFIX_LEFT の使用例を示します。
5 * ファイルシステムの階層構造をツリー形式で表示し、そのプレフィックスをカスタマイズします。
6 */
7function demonstrateRecursiveTreeIteratorPrefixLeft(): void
8{
9    // 一時ディレクトリを作成し、サンプルファイル・ディレクトリを準備します。
10    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_tree_demo_' . uniqid();
11    mkdir($tempDir, 0777, true); // ベースディレクトリを作成
12
13    // サブディレクトリを作成します。
14    mkdir($tempDir . DIRECTORY_SEPARATOR . 'src', 0777);
15    mkdir($tempDir . DIRECTORY_SEPARATOR . 'src' . DIRECTORY_SEPARATOR . 'Controllers', 0777);
16    mkdir($tempDir . DIRECTORY_SEPARATOR . 'public', 0777);
17
18    // ファイルを作成します。
19    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'README.md', '...');
20    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'src' . DIRECTORY_SEPARATOR . 'index.php', '<?php // src/index.php');
21    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'src' . DIRECTORY_SEPARATOR . 'Controllers' . DIRECTORY_SEPARATOR . 'UserController.php', '<?php // src/Controllers/UserController.php');
22    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'public' . DIRECTORY_SEPARATOR . 'index.php', '<?php // public/index.php');
23
24    echo "--- ツリー構造の表示 (カスタムプレフィックス) ---\n";
25
26    try {
27        // RecursiveDirectoryIterator を使って指定されたディレクトリを再帰的に走査します。
28        // RecursiveDirectoryIterator::SKIP_DOTS は、"." と ".." エントリをスキップします。
29        $directoryIterator = new RecursiveDirectoryIterator(
30            $tempDir,
31            RecursiveDirectoryIterator::SKIP_DOTS
32        );
33
34        // RecursiveIteratorIterator を使って、再帰的なイテレータをフラットに扱えるようにします。
35        // RecursiveIteratorIterator::SELF_FIRST は、ディレクトリ自体をその内容の前に返します。
36        $recursiveIterator = new RecursiveIteratorIterator($directoryIterator, RecursiveIteratorIterator::SELF_FIRST);
37
38        // RecursiveTreeIterator を使って、イテレータの内容をツリー形式で表示します。
39        $treeIterator = new RecursiveTreeIterator($recursiveIterator);
40
41        // RecursiveTreeIterator::PREFIX_LEFT 定数を使って、ツリー表示の左側のプレフィックスをカスタマイズします。
42        // この定数は setPrefixPart() メソッドの第一引数として利用され、どの部分のプレフィックスを変更するかを指定します。
43        // PREFIX_LEFT はツリーの「枝」や「垂直線」を示す部分の左端の表示を変更するために使われます。
44        $treeIterator->setPrefixPart(RecursiveTreeIterator::PREFIX_LEFT, '├── '); // 通常の枝
45        $treeIterator->setPrefixPart(RecursiveTreeIterator::PREFIX_END, '└── '); // 最後の枝
46        $treeIterator->setPrefixPart(RecursiveTreeIterator::PREFIX_MID, '│   ');  // 中間の垂直線
47        $treeIterator->setPrefixPart(RecursiveTreeIterator::PREFIX_CONT, '    '); // 継続線（子要素がない場合のインデント）
48
49        foreach ($treeIterator as $name => $file) {
50            // getPrefix() で現在の要素に適用されているプレフィックス文字列を取得し、ファイル名と結合して出力します。
51            echo $treeIterator->getPrefix() . $file->getFilename() . "\n";
52        }
53
54    } catch (Exception $e) {
55        echo "エラーが発生しました: " . $e->getMessage() . "\n";
56    } finally {
57        // 後処理: 作成した一時ディレクトリとファイルを削除します。
58        // この部分はデモンストレーションのためのクリーンアップであり、運用環境ではより堅牢なエラーハンドリングと削除ロジックが必要です。
59        if (is_dir($tempDir)) {
60            $files = new RecursiveIteratorIterator(
61                new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
62                RecursiveIteratorIterator::CHILD_FIRST
63            );
64            foreach ($files as $fileinfo) {
65                if ($fileinfo->isDir()) {
66                    rmdir($fileinfo->getRealPath());
67                } else {
68                    unlink($fileinfo->getRealPath());
69                }
70            }
71            rmdir($tempDir);
72            echo "--- 一時ディレクトリ '$tempDir' をクリーンアップしました。---\n";
73        }
74    }
75}
76
77// 関数を実行
78demonstrateRecursiveTreeIteratorPrefixLeft();

PHP 8のRecursiveTreeIterator::PREFIX_LEFTは、RecursiveTreeIteratorクラスに属する定数です。この定数は、ファイルシステムなどの階層構造をツリー形式で表示する際に、その見た目をカスタマイズするために使用されます。具体的には、ツリー表示の左側に表示される「枝」や「垂直線」といったプレフィックス部分を制御する際に利用されます。

サンプルコードでは、一時的なファイルシステム構造を作成し、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを使ってその内容を再帰的に取得しています。取得した情報をRecursiveTreeIteratorに渡し、setPrefixPart()メソッドを通じてPREFIX_LEFT定数をはじめとする様々な定数（PREFIX_END, PREFIX_MID, PREFIX_CONT）と組み合わせることで、ツリーの各要素に表示されるカスタムのプレフィックス文字列（例: ├── , └── , │ ）を設定しています。

PREFIX_LEFTは、setPrefixPart()メソッドの第一引数として指定され、ツリー内の「通常の枝」部分の表示を調整します。これにより、出力されるツリー表示がより構造的で視覚的に分かりやすくなります。この定数自体に引数はなく、戻り値もありません。単に特定のプレフィックス部分を識別するための識別子として機能し、開発者がツリー表示の細かい表現を柔軟にカスタマイズできるよう支援します。