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

『getMaxDepthメソッドは、RecursiveIteratorIteratorオブジェクトが再帰的な反復処理を行う際に、たどることが許されている最大の深さ（深度）を取得するために実行するメソッドです。RecursiveIteratorIteratorは、多次元配列やディレクトリ構造のような階層を持つデータを扱う際に、どの階層まで処理を進めるかを制限する機能を持っています。この深さの制限は、通常setMaxDepthメソッドによって事前に設定されます。getMaxDepthメソッドは、そのようにして現在設定されている深さの上限値がいくつかを確認する役割を担います。メソッドを呼び出した際の返り値は、setMaxDepthで整数値が設定されていればその整数値が返されます。一方で、特に深さの制限が設定されていないデフォルトの状態ではfalseが返されます。このfalseという値は、深さに制限がなく、可能な限りすべての階層をたどる設定であることを意味します。このメソッドにより、現在のイテレータの動作設定をプログラムで動的に把握することが可能になります。

Copy
1<?php
2
3$array = [
4    'item1',
5    [
6        'item2',
7        'item3'
8    ]
9];
10
11$arrayIterator = new RecursiveArrayIterator($array);
12$iterator = new RecursiveIteratorIterator($arrayIterator);
13
14// 最大の反復深度を設定します
15$iterator->setMaxDepth(2);
16
17// 設定されている最大の反復深度を取得します
18$maxDepth = $iterator->getMaxDepth();
19
20var_dump($maxDepth);
21
22?>

引数なし

引数はありません

int

このメソッドは、再帰イテレータの最大深度を示す整数値を返します。