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

Copy
1<?php
2
3/**
4 * テスト用のディレクトリ構造を作成します。
5 * RecursiveTreeIteratorの動作確認のための一時的なファイルとフォルダを準備します。
6 *
7 * @param string $baseDir 作成するベースディレクトリのパス
8 */
9function createTestDirectoryStructure(string $baseDir): void
10{
11    if (!is_dir($baseDir)) {
12        mkdir($baseDir);
13    }
14
15    file_put_contents($baseDir . '/file_a.txt', 'Content A');
16    file_put_contents($baseDir . '/file_d.txt', 'Content D');
17
18    $subDir1 = $baseDir . '/subdir_1';
19    if (!is_dir($subDir1)) {
20        mkdir($subDir1);
21    }
22    file_put_contents($subDir1 . '/file_b.txt', 'Content B');
23
24    $subDir2 = $subDir1 . '/subdir_2';
25    if (!is_dir($subDir2)) {
26        mkdir($subDir2);
27    }
28    file_put_contents($subDir2 . '/file_c.txt', 'Content C');
29}
30
31/**
32 * 作成したテスト用のディレクトリ構造を削除します。
33 * テスト後のクリーンアップを行います。
34 *
35 * @param string $baseDir 削除するベースディレクトリのパス
36 */
37function removeTestDirectoryStructure(string $baseDir): void
38{
39    if (!is_dir($baseDir)) {
40        return;
41    }
42
43    // ディレクトリとその内容を再帰的に削除します。
44    $iterator = new RecursiveDirectoryIterator($baseDir, RecursiveDirectoryIterator::SKIP_DOTS);
45    $files = new RecursiveIteratorIterator($iterator, RecursiveIteratorIterator::CHILD_FIRST);
46
47    foreach ($files as $file) {
48        if ($file->isDir()) {
49            rmdir($file->getRealPath());
50        } else {
51            unlink($file->getRealPath());
52        }
53    }
54    rmdir($baseDir);
55}
56
57// スクリプトが実行されているディレクトリに一時的なテストディレクトリを作成します。
58$base_dir = __DIR__ . '/recursive_tree_test_data';
59createTestDirectoryStructure($base_dir);
60
61try {
62    // 1. RecursiveDirectoryIterator を使用して、指定されたディレクトリを再帰的に走査します。
63    //    SKIP_DOTS フラグは、"." と ".." エントリをスキップするために使用します。
64    $directory_iterator = new RecursiveDirectoryIterator($base_dir, RecursiveDirectoryIterator::SKIP_DOTS);
65
66    // 2. RecursiveTreeIterator は、再帰イテレータの各要素の表示にプレフィックスを追加し、
67    //    ツリー構造を視覚的に表現するのに役立ちます。
68    //    BYPASS_KEY と BYPASS_CURRENT は、イテレータがキーと現在の要素を自動的に生成し、
69    //    標準のツリー表示形式にフィットするようにします。
70    $tree_iterator = new RecursiveTreeIterator(
71        $directory_iterator,
72        RecursiveTreeIterator::BYPASS_KEY | RecursiveTreeIterator::BYPASS_CURRENT
73    );
74
75    echo "--- デフォルトのツリー表示 ---" . PHP_EOL;
76    // デフォルトのプレフィックスでツリー構造を表示します。
77    foreach ($tree_iterator as $item) {
78        echo $item . PHP_EOL;
79    }
80    echo PHP_EOL;
81
82    // 3. setPrefixPart メソッドを使用して、ツリー表示のプレフィックスをカスタマイズします。
83    //    これは、特定の種類の要素（ディレクトリ、ファイルなど）の前に表示される文字列を設定します。
84    //    "php setparameter" の概念に沿い、表示に関するパラメーターをプログラムで設定する方法を示します。
85
86    echo "--- カスタムプレフィックスでのツリー表示 ---" . PHP_EOL;
87
88    // ディレクトリを示すプレフィックスを設定します。
89    // RecursiveTreeIterator::PREFIX_PART_DIR は、ディレクトリのエントリに対して使用されるプレフィックスの部分を指定します。
90    // 通常は垂直線 (│) の部分に相当しますが、ここではより視覚的にディレクトリとわかるようにします。
91    // 例えば、`|-- ` の代わりに `[DIR] ` を使用します。
92    $tree_iterator->setPrefixPart(RecursiveTreeIterator::PREFIX_PART_DIR, '[DIR] ');
93
94    // ファイルを示すプレフィックスを設定します。
95    // RecursiveTreeIterator::PREFIX_PART_FILE は、ファイルのエントリに対して使用されるプレフィックスの部分を指定します。
96    // 通常はツリーの分岐線 (├── または └──) の部分に相当します。
97    // ここでは、ファイルを示す線 `|   ` を `[FILE] ` に変更します。
98    $tree_iterator->setPrefixPart(RecursiveTreeIterator::PREFIX_PART_FILE, '[FILE] ');
99
100    // 各要素の最終部分に特定のプレフィックスを追加します。
101    // RecursiveTreeIterator::PREFIX_PART_LAST は、ツリー構造の各要素の直前に適用される最後のプレフィックス部分を指定します。
102    // ここでは、常に `>> ` を追加します。
103    $tree_iterator->setPrefixPart(RecursiveTreeIterator::PREFIX_PART_LAST, '>> ');
104
105    // カスタマイズされたプレフィックスでツリー構造を再度表示します。
106    foreach ($tree_iterator as $item) {
107        echo $item . PHP_EOL;
108    }
109
110} catch (Exception $e) {
111    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
112} finally {
113    // テスト終了後、作成したディレクトリとファイルをクリーンアップします。
114    removeTestDirectoryStructure($base_dir);
115}

PHPのRecursiveTreeIteratorは、ディレクトリ構造のような階層データをツリー状に視覚的に表示するためのクラスです。このサンプルコードは、まず指定されたディレクトリ構造をデフォルトの形式でツリー表示し、その後setPrefixPartメソッドを使ってその表示形式をカスタマイズする方法を示しています。

setPrefixPartメソッドは、ツリー表示の各行の先頭に付与されるプレフィックスの一部を変更する機能を提供します。第一引数int $partには、変更したいプレフィックスの種類をRecursiveTreeIteratorクラスが持つ定数（例: PREFIX_PART_DIRでディレクトリ部分、PREFIX_PART_FILEでファイル部分、PREFIX_PART_LASTで最終要素前の部分）で指定します。第二引数string $valueには、その部分に設定したい新しいプレフィックス文字列を渡します。これにより、デフォルトの記号ベースの表示から、[DIR] や[FILE] のような独自の文字列に置き換えることが可能です。このメソッドはvoidを返すため、直接的な戻り値はありませんが、呼び出したRecursiveTreeIteratorオブジェクトの内部状態が変更され、その後のツリー表示に設定が反映されます。これは、表示に関わるパラメータをプログラムから設定する、いわゆる「php setparameter」の一例です。

Copy
1<?php
2
3/**
4 * RecursiveTreeIterator の setPrefixPart メソッドの使用例
5 *
6 * このコードは、階層的なデータ（配列）をツリー形式で表示し、
7 * setPrefixPart メソッドを使ってツリーの表示形式（プレフィックス）をカスタマイズする方法を示します。
8 * RecursiveTreeIterator は、再帰的なデータ構造を視覚的に分かりやすく表示する際に便利です。
9 */
10
11// 階層的なデータ構造の例を定義します。
12$data = [
13    'Fruits' => [
14        'Apple',
15        'Banana',
16        'Orange',
17    ],
18    'Vegetables' => [
19        'Carrot',
20        'Broccoli',
21        'Spinach',
22        'Potatoes' => [
23            'Russet',
24            'Yukon Gold',
25        ],
26    ],
27    'Grains' => [
28        'Rice',
29        'Wheat',
30    ],
31];
32
33// RecursiveArrayIterator を使用して、配列を再帰的に反復可能なオブジェクトに変換します。
34$arrayIterator = new RecursiveArrayIterator($data);
35
36// RecursiveTreeIterator を作成し、ツリー形式でデータを表示します。
37// RecursiveTreeIterator::BYPASS_CURRENT_KEY は、ツリー表示時にキーも出力するために使用します。
38$treeIterator = new RecursiveTreeIterator($arrayIterator, RecursiveTreeIterator::BYPASS_CURRENT_KEY);
39
40// setPrefixPart メソッドを使用して、ツリー表示のプレフィックス（接頭辞）の一部を設定します。
41// これにより、ツリーの各ノードのインデントや接続線の表示スタイルをカスタマイズできます。
42
43// 子を持つ中間ノードのプレフィックスを設定 (例: ツリーの分岐点に表示)
44// RecursiveTreeIterator::PREFIX_MID_HAS_CHILDREN は、子要素を持つ中間ノードのプレフィックスを指します。
45$treeIterator->setPrefixPart(RecursiveTreeIterator::PREFIX_MID_HAS_CHILDREN, '[+] ');
46
47// 最後の枝の中間ノードのプレフィックスを設定 (例: 親ノードからの最後の分岐点に表示)
48// RecursiveTreeIterator::PREFIX_MID_LAST_CHILD は、最後の枝の中間ノードのプレフィックスを指します。
49$treeIterator->setPrefixPart(RecursiveTreeIterator::PREFIX_MID_LAST_CHILD, '└── ');
50
51// 左端のプレフィックス（インデント）を設定 (例: 各階層のインデントの深さを調整)
52// RecursiveTreeIterator::PREFIX_LEFT は、ツリーの左端のインデント部分を指します。
53$treeIterator->setPrefixPart(RecursiveTreeIterator::PREFIX_LEFT, '    '); // スペース4つでインデントを深くする
54
55// 右端のプレフィックス（データ本体への接続）を設定 (例: プレフィックスとデータ間の接続文字)
56// RecursiveTreeIterator::PREFIX_RIGHT は、プレフィックスと実際のデータの間を接続する部分を指します。
57$treeIterator->setPrefixPart(RecursiveTreeIterator::PREFIX_RIGHT, '-> ');
58
59
60echo "カスタマイズされたツリー表示の例:\n";
61// RecursiveTreeIterator を反復処理し、設定されたプレフィックスでツリーを表示します。
62foreach ($treeIterator as $item) {
63    echo $item . "\n";
64}
65

PHPのRecursiveTreeIteratorクラスは、配列のような階層的なデータをツリー形式で表示するためのものです。このクラスに属するsetPrefixPartメソッドは、ツリー表示の見た目、特に各ノードの前に表示されるプレフィックス（接頭辞）を細かくカスタマイズするために使用されます。

引数$partには、カスタマイズしたいプレフィックスの種類をRecursiveTreeIteratorクラスの定数で指定します。例えば、RecursiveTreeIterator::PREFIX_MID_HAS_CHILDRENは子要素を持つ中間ノードのプレフィックスを指します。引数$valueには、その部分に表示したい文字列を設定します。戻り値はvoidであり、このメソッド自体は値を返さず、オブジェクトの内部状態（ツリーの表示設定）を変更するだけです。

サンプルコードでは、まず階層的なデータが定義され、それをRecursiveTreeIteratorでツリー表示する準備をしています。その後、setPrefixPartメソッドを複数回呼び出し、ツリーの各要素に表示される接続線やインデントをカスタマイズしています。具体的には、子要素を持つ中間ノードの表示を[+] に、最後の分岐点を└── に、インデントをスペース4つに、そしてプレフィックスとデータ本体の接続部分を-> にそれぞれ設定しています。これにより、デフォルトの表示ではなく、視覚的に分かりやすい、あるいは独自のスタイルを持つツリー構造を柔軟に構築できます。このメソッドを使うことで、階層データのデバッグ表示やユーザーインターフェースでのツリー構造の出力など、様々な場面でツリーの見た目を意図通りに制御できるようになります。