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

PREFIX_LEFT定数は、RecursiveTreeIteratorクラスが生成するツリー表示において、接頭辞の左側部分を指し示すために使われる定数です。RecursiveTreeIteratorクラスは、ファイルシステムや多次元配列のような階層構造を持つデータを、テキストベースのツリー形式で視覚的に表示する機能を提供します。このツリー表示では、各項目の階層の深さを示すために、項目の前に「│ 」や「├─」といった接頭辞が自動的に付与されます。setPrefixPart()メソッドを使用すると、この接頭辞を構成する各パーツの文字を自由に変更することが可能です。PREFIX_LEFT定数は、このsetPrefixPart()メソッドの第一引数として使用され、ツリーの幹となり、同じ階層が続くことを示す垂直線の部分（デフォルトでは「│ 」）を特定します。この定数を利用して、例えば垂直線を別の文字に変更したり、空白にして非表示にしたりすることで、出力されるツリーの見た目を細かくカスタマイズできます。これは、ツリー表示のデザインを柔軟に調整する上で重要な役割を果たします。

Copy
1<?php
2
3$data = [
4    'fruits' => ['apple', 'orange'],
5    'vegetables' => ['carrot', 'pea'],
6];
7
8$iterator = new RecursiveTreeIterator(
9    new RecursiveArrayIterator($data)
10);
11
12// 各階層の最後の要素に使われる接頭辞を設定します
13$iterator->setPrefixPart(RecursiveTreeIterator::PREFIX_LEFT, '└── ');
14
15foreach ($iterator as $line) {
16    echo $line . PHP_EOL;
17}
18
19?>

引数なし

引数はありません

戻り値なし

戻り値はありません