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

BYPASS_CURRENT定数は、RecursiveTreeIteratorクラスの動作を制御するために使用される定数です。RecursiveTreeIteratorクラスは、配列やオブジェクトのような再帰的なデータ構造を、ツリー形式で反復処理する際に用いられます。この定数は、インスタンス生成時にフラグとして設定することで、current()メソッドの振る舞いを変更する役割を持ちます。通常、current()メソッドは現在位置の要素そのものを返しますが、BYPASS_CURRENTフラグが有効な場合、current()メソッドは要素を返さず、代わりにツリーの階層構造を表現するための接頭辞と接尾辞を連結した文字列を返します。この接頭辞はgetPrefix()メソッドによって生成され、「|-」や空白といったツリーの枝を表す記号が含まれます。この動作により、要素自体の値は取得せずに、ツリーの構造を描画するために必要な部分だけを効率的に取り出すことが可能になります。この定数は、主にRecursiveTreeIteratorの内部的な描画ロジックをカスタマイズする高度なケースで利用されます。

Copy
1<?php
2
3$data = [
4    'fruits' => ['apple', 'banana'],
5    'vegetables' => ['carrot', 'potato'],
6];
7
8$arrayIterator = new RecursiveArrayIterator($data);
9
10// RecursiveTreeIteratorのコンストラクタで BYPASS_CURRENT フラグを使用します。
11// これにより、親ノード（'fruits', 'vegetables'）自体は出力されず、
12// 子ノード（'apple', 'banana' など）のみが処理されます。
13$treeIterator = new RecursiveTreeIterator(
14    $arrayIterator,
15    RecursiveTreeIterator::BYPASS_CURRENT
16);
17
18foreach ($treeIterator as $value) {
19    echo $treeIterator->getPrefix() . $value . PHP_EOL;
20}
21
22?>

引数なし

引数はありません

int

RecursiveTreeIterator::BYPASS_CURRENT は、int 型の定数であり、イテレーターの現在の要素をスキップする際に使用されます。