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

Copy
1<?php
2
3/**
4 * RecursiveIteratorIterator::valid() を使用して、
5 * イテレータの現在の位置が有効かどうかを検証するサンプルコード。
6 *
7 * この関数は、多次元配列を受け取り、whileループとvalid()メソッドを使って
8 * 再帰的にすべての値をフラットに出力します。
9 *
10 * @param array $data 処理対象の多次元配列
11 * @return void
12 */
13function processNestedArray(array $data): void
14{
15    // 多次元配列から再帰的なイテレータを作成
16    $arrayIterator = new RecursiveArrayIterator($data);
17    $iterator = new RecursiveIteratorIterator($arrayIterator);
18
19    // イテレータを先頭に巻き戻す
20    $iterator->rewind();
21
22    // valid()メソッドで現在のイテレータの位置が有効か検証し、ループを継続
23    while ($iterator->valid()) {
24        // 現在のキーと値を取得して出力
25        // getDepth()で現在の階層の深さを取得
26        echo str_repeat('  ', $iterator->getDepth());
27        echo $iterator->key() . ': ' . $iterator->current() . PHP_EOL;
28
29        // イテレータを次の要素に進める
30        $iterator->next();
31    }
32}
33
34// サンプルデータとなる多次元配列
35$userData = [
36    'name' => 'Taro Yamada',
37    'email' => 'taro@example.com',
38    'skills' => [
39        'languages' => ['PHP', 'JavaScript'],
40        'frameworks' => [
41            'backend' => 'Laravel',
42            'frontend' => 'Vue.js'
43        ]
44    ]
45];
46
47// 関数を実行
48processNestedArray($userData);
49
50?>

このPHPコードは、RecursiveIteratorIteratorクラスのvalid()メソッドの使用例を示しています。valid()メソッドは、イテレータの現在の位置が有効かどうか、つまり処理すべき要素がまだ存在するかどうかを判定します。このメソッドは引数を取らず、現在の位置が有効であればtrueを、終端に達してこれ以上要素がなければfalseを戻り値として返します。

サンプルコードでは、まず多次元配列からRecursiveIteratorIteratorオブジェクトを生成し、ネストされた配列の全要素をフラットに扱えるようにしています。whileループの条件式に$iterator->valid()を指定することで、「イテレータが有効な要素を指している間」だけループ処理が継続される仕組みです。ループ内部では、key()とcurrent()で現在のキーと値を取得して出力し、next()でイテレータを次の要素へ進めます。すべての要素を処理し終えるとvalid()がfalseを返すため、ループは安全に終了します。このようにvalid()は、繰り返し処理を制御する上で重要な役割を果たします。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * RecursiveIteratorIterator::valid() の使用例を示します。
7 *
8 * `valid()` メソッドは、イテレータの現在の位置が有効かどうかを検証 (validate) します。
9 * ループ処理において、まだ処理すべき要素が存在するかどうかを確認するために使われ、
10 * `true` であれば要素が存在し、`false` であればループの終端に達したことを意味します。
11 *
12 * このサンプルでは、while ループと `valid()` を組み合わせて、
13 * `foreach` と同等の処理を明示的に実装し、`valid()` の役割を解説します。
14 */
15function demonstrateIteratorValidation(): void
16{
17    // 再帰的な構造を持つ多次元配列（ファイルシステムの例）
18    $fileSystem = [
19        'documents' => [
20            'report.docx',
21            'resume.pdf',
22        ],
23        'images' => [
24            'vacation' => [
25                'beach.jpg',
26                'mountain.png',
27            ],
28            'profile.jpg',
29        ],
30    ];
31
32    // 配列を再帰的に走査するためのイテレータを作成
33    $arrayIterator = new RecursiveArrayIterator($fileSystem);
34    // RecursiveIteratorIterator で再帰的なイテレータをフラットに扱う
35    $iterator = new RecursiveIteratorIterator(
36        $arrayIterator,
37        RecursiveIteratorIterator::LEAVES_ONLY // 末端の要素（ファイル）のみを対象とする
38    );
39
40    echo "--- ファイル一覧 ---" . PHP_EOL;
41
42    // イテレータを先頭の位置に巻き戻す
43    $iterator->rewind();
44
45    // valid() が true を返す間 (イテレータが有効な位置を指している間) ループを続ける
46    while ($iterator->valid()) {
47        // 現在の要素（ファイル名）を取得して表示
48        echo "- " . $iterator->current() . PHP_EOL;
49
50        // イテレータを次の要素に進める
51        $iterator->next();
52    }
53
54    echo "--- 処理終了 ---" . PHP_EOL;
55    echo "ループが終了しました。valid() が false を返したためです。" . PHP_EOL;
56}
57
58// 関数を実行して動作を確認
59demonstrateIteratorValidation();

RecursiveIteratorIterator::valid()メソッドは、イテレータが現在指している位置に、処理すべき要素が存在するかどうかを検証するためのメソッドです。このメソッドは引数を取りません。戻り値として真偽値（bool型）を返し、処理できる要素がまだ存在する場合はtrueを、イテレータがコレクションの終端に達してこれ以上要素がない場合はfalseを返します。

サンプルコードでは、多次元配列で表現されたファイル構造を再帰的に走査しています。ここでは一般的なforeachループの代わりに、whileループとvalid()メソッドを組み合わせて、イテレータの内部的な動作を明示的に示しています。

while ($iterator->valid())というループの継続条件は、「イテレータが有効な要素を指している間は処理を続ける」という意味になります。valid()がtrueを返す限りループは続き、current()で現在の要素（ファイル名）を取得し、next()で次の要素へと進みます。すべての要素を処理し終えると、valid()はfalseを返すため、whileループは終了します。このように、valid()はループ処理を続けるべきか判断する上で中心的な役割を果たします。