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

Copy
1<?php
2
3/**
4 * CachingIterator::valid() を使用してイテレータの有効性を検証する例
5 *
6 * CachingIterator::valid() は、現在のイテレータの位置に有効な要素が存在するかどうかを
7 * bool値で返します。主にループの継続条件として使用されます。
8 *
9 * @return void
10 */
11function demonstrateCachingIteratorValid(): void
12{
13    // イテレーションの対象となる配列
14    $data = ['Apple', 'Banana', 'Cherry'];
15
16    // 配列をラップする CachingIterator インスタンスを作成
17    $iterator = new CachingIterator(new ArrayIterator($data));
18
19    // valid() が true を返す間、ループを継続する
20    // これにより、有効な要素がなくなるまで安全に処理を続けられます
21    while ($iterator->valid()) {
22        // 現在の要素を取得して出力
23        echo "Current item: " . $iterator->current() . PHP_EOL;
24
25        // 次の要素へイテレータを進める
26        $iterator->next();
27    }
28
29    // ループが終了した時点では、イテレータは無効な位置を指している
30    // そのため、valid() は false を返す
31    if (!$iterator->valid()) {
32        echo "Iteration has finished. The iterator is no longer valid." . PHP_EOL;
33    }
34}
35
36// 関数を実行して動作を確認
37demonstrateCachingIteratorValid();
38

PHPのCachingIterator::valid()メソッドは、イテレータが現在指している位置に有効な要素が存在するかどうかを検証します。このメソッドは引数を必要としません。

戻り値は真偽値（bool型）です。イテレータの現在の位置にアクセス可能な要素があればtrueを、なければfalseを返します。配列の最後の要素を処理し終えた後など、イテレータが有効な範囲外を指している場合にfalseが返されます。

サンプルコードでは、配列を元にCachingIteratorのインスタンスを生成しています。そして、whileループの継続条件として$iterator->valid()を使用しています。これにより、有効な要素が存在する間だけループが実行されます。ループ内ではcurrent()で現在の要素を取得し、next()でイテレータを次の要素に進めています。

配列の最後の要素の処理が終わると、イテレータは終端を超えた位置を指すため、次にvalid()が呼ばれたときにはfalseが返され、ループは安全に停止します。このように、valid()はループ処理において、存在しない要素にアクセスしようとするエラーを防ぐための重要な役割を果たします。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * CachingIterator::valid() の動作を検証するサンプルコード
7 *
8 * CachingIteratorは、内部のイテレータをラップし、
9 * 次の要素が存在するかどうかを事前に確認できる hasNext() メソッドを提供します。
10 *
11 * valid() メソッドは、現在のイテレータの位置が有効かどうか（つまり、要素が存在するかどうか）を
12 * bool値で返します。while ループと組み合わせることで、イテレータが終端に達するまで
13 * 安全に要素を処理できます。
14 */
15function demonstrateCachingIteratorValid(): void
16{
17    // サンプルとなるフルーツの配列
18    $fruits = [
19        'a' => 'Apple',
20        'b' => 'Banana',
21        'c' => 'Cherry',
22    ];
23
24    // 配列を ArrayIterator に変換し、さらに CachingIterator でラップする
25    $iterator = new CachingIterator(new ArrayIterator($fruits));
26
27    echo "フルーツリストの処理を開始します...\n";
28    echo "--------------------------------\n";
29
30    // $iterator->valid() が true を返す間、ループを継続する
31    // イテレータが配列の終端を超えると、valid() は false を返し、ループは終了する
32    while ($iterator->valid()) {
33        // 現在のキーと値を取得して表示
34        $key = $iterator->key();
35        $value = $iterator->current();
36        echo "[キー: {$key}] 値: {$value}" . PHP_EOL;
37
38        // CachingIterator の特徴である hasNext() を使って次の要素の存在を確認
39        if ($iterator->hasNext()) {
40            echo "  -> 次の要素があります。\n";
41        } else {
42            echo "  -> これが最後の要素です。\n";
43        }
44
45        // イテレータを次の要素へ進める
46        $iterator->next();
47    }
48
49    echo "--------------------------------\n";
50    echo "処理が完了しました。\n";
51}
52
53// 関数を実行
54demonstrateCachingIteratorValid();
55
56?>

CachingIterator::valid()メソッドは、イテレータの現在の位置に有効な要素が存在するかどうかを判定します。このメソッドに引数は必要ありません。戻り値は真偽値（bool）で、現在の位置に要素が存在すればtrueを、配列などの終端を超えて要素が存在しない場合はfalseを返します。

サンプルコードでは、フルーツの配列をCachingIteratorで処理する際に、whileループの条件式として$iterator->valid()が使用されています。ループが開始されると、イテレータは配列の先頭から順に要素を指します。valid()がtrueを返す間はループが継続され、各要素のキーと値が表示されます。

ループ内で$iterator->next()が実行されるたびに、イテレータは次の要素へと進みます。最後の要素の処理が終わった後にnext()が呼ばれると、イテレータは終端を超えた位置を指すことになります。この状態で次のループ条件を評価する際、valid()はfalseを返すため、ループは安全に終了します。このようにvalid()は、イテレータが持つ全ての要素を確実に処理するために不可欠なメソッドです。