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

PREFIX_RIGHT定数は、RecursiveTreeIteratorクラスが生成するツリー表示において、同じ階層における最後の要素を示す接頭辞部分を指定するための定数です。RecursiveTreeIteratorは、配列やディレクトリ構造のような再帰的なデータを、テキストベースのツリー形式で視覚的に分かりやすく表示するために使用されます。このツリーは、罫線文字を組み合わせて描画されますが、PREFIX_RIGHTは、その階層の兄弟要素の中で一番最後に位置する要素の前に付加される記号、具体的には「└」のような角の部分に対応します。プログラマはsetPrefixPartメソッドを使用する際に、第一引数にこの定数を指定することで、最後の要素に使われる接頭辞の文字列を任意にカスタマイズすることが可能です。例えば、setPrefixPart(RecursiveTreeIterator::PREFIX_RIGHT, "└─")と設定することで、ツリーの末端の見た目を変更できます。この定数は、中間要素を表すPREFIX_MIDや、親子関係を示すための縦線を表すPREFIX_LEFTといった他の接頭辞用定数と連携して、構造全体の可読性を高めるために利用されます。

Copy
1<?php
2
3$data = [
4    'fruits' => ['apple', 'banana'],
5    'vegetables' => [
6        'green' => ['pea', 'broccoli'],
7        'orange' => ['carrot']
8    ]
9];
10
11$arrayIterator = new RecursiveArrayIterator($data);
12
13$treeIterator = new RecursiveTreeIterator(
14    $arrayIterator,
15    RecursiveTreeIterator::PREFIX_RIGHT
16);
17
18foreach ($treeIterator as $key => $value) {
19    echo $value . PHP_EOL;
20}

引数なし

引数はありません

int

RecursiveTreeIterator::PREFIX_RIGHT は、ツリー構造の右側のノードを表すための整数定数です。この定数は、ツリーの要素を反復処理する際に、特定のノードが右側にあることを識別するために使用されます。