【PHP8.x】hasChildrenメソッドの使い方

『hasChildrenメソッドは、イテレータの現在の要素が子要素を持つかどうかをチェックするメソッドです』

このメソッドは、再帰的なデータ構造を扱うRecursiveFilterIteratorクラスの一部として機能します。例えば、ディレクトリ構造を走査している際に、現在の要素がサブディレクトリ（子要素を持つ）なのか、それともファイル（子要素を持たない）なのかを判断するために使用されます。メソッドが呼び出されると、内部的に保持しているイテレータのhasChildrenメソッドを実行し、その結果を返します。現在の要素が子要素を持つ場合はtrueを、持たない場合はfalseを返すというシンプルな動作をします。このメソッドは、RecursiveFilterIteratorを継承して独自のフィルタクラスを作成する際に特に有用です。例えば、acceptメソッド内でこのhasChildrenメソッドの戻り値を利用して、子要素を持つディレクトリのみを処理の対象にしたり、逆に子要素を持たない末端の要素だけを抽出したりするなど、階層構造に応じた柔軟なフィルタリングロジックを実装するための重要な判断材料となります。

Copy
1<?php
2
3// RecursiveFilterIterator を継承したクラスを定義
4class MyFilter extends RecursiveFilterIterator
5{
6    // フィルタ条件を定義するために accept() メソッドを実装する必要があります
7    public function accept(): bool
8    {
9        return true; // この例では全ての要素を許可します
10    }
11}
12
13// 子要素を含む多次元配列
14$data = [
15    "Scalar Item",
16    "Array Item" => [
17        "Child 1",
18        "Child 2"
19    ]
20];
21
22// RecursiveIterator のインスタンスを作成
23$arrayIterator = new RecursiveArrayIterator($data);
24
25// RecursiveFilterIterator のインスタンスを作成
26$filterIterator = new MyFilter($arrayIterator);
27
28
29// イテレータを最初の要素 "Scalar Item" にセット
30$filterIterator->rewind();
31
32// public RecursiveFilterIterator::hasChildren(): bool
33// "Scalar Item" は子を持たないため、false が返されます
34$result1 = $filterIterator->hasChildren();
35var_dump($result1);
36
37
38// イテレータを次の要素 "Array Item" に進める
39$filterIterator->next();
40
41// "Array Item" は子を持つため、true が返されます
42$result2 = $filterIterator->hasChildren();
43var_dump($result2);
44
45?>

引数なし

引数はありません

bool

現在のイテレータが子要素を持つ場合にtrueを、そうでない場合にfalseを返します。