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

Copy
1<?php
2
3/**
4 * InfiniteIterator::valid() メソッドの動作をデモンストレーションする関数。
5 *
6 * この関数は、InfiniteIterator が内部イテレータを繰り返し処理し、
7 * valid() メソッドがイテレータの現在位置が有効であるかをどのようにチェックするかを示します。
8 * InfiniteIterator の場合、有効な要素が常に提供されるため、valid() は通常 true を返します。
9 * システムエンジニアを目指す初心者の方へ: valid() はイテレータが「正当な状態」であるかを検証します。
10 * InfiniteIterator では、この「正当な状態」が無限に続くため、ループは外部の条件で制御する必要があります。
11 */
12function demonstrateInfiniteIteratorValid(): void
13{
14    echo "--- InfiniteIterator::valid() メソッドのデモンストレーション ---\n";
15
16    // 1. サンプルデータを含むArrayIteratorを作成
17    $data = ['Apple', 'Banana', 'Cherry'];
18    $arrayIterator = new ArrayIterator($data);
19
20    // 2. ArrayIterator を InfiniteIterator でラップする
21    //    これにより、ArrayIterator が末尾に達しても最初から繰り返されるようになります。
22    $infiniteIterator = new InfiniteIterator($arrayIterator);
23
24    echo "\nInfiniteIterator は内部イテレータが終了しても、要素を繰り返し提供します。\n";
25    echo "valid() メソッドは、現在のイテレータ位置が有効かどうか (要素を提供できるか) を検証します。\n";
26    echo "InfiniteIterator の場合、無限に要素を提供し続けるため、通常は常に true を返します。\n";
27
28    $maxIterations = 7; // 無限ループを避けるため、最大イテレーション数を設定
29    $count = 0;
30
31    // 3. イテレータを手動で操作し、valid() の戻り値を確認
32    $infiniteIterator->rewind(); // イテレータを最初の位置に巻き戻す
33
34    echo "\nイテレータの状態をチェックします (最大 {$maxIterations} 回のループ):\n";
35    while ($infiniteIterator->valid() && $count < $maxIterations) {
36        // valid() メソッドは、現在のイテレータ位置が有効であれば true を返します。
37        // InfiniteIterator では、常に true が返されることが期待されます。
38        echo sprintf(
39            "  Iteration %d: current() = '%s', valid() = %s\n",
40            $count + 1,
41            $infiniteIterator->current(),
42            $infiniteIterator->valid() ? 'true' : 'false' // valid() の戻り値を確認
43        );
44
45        $infiniteIterator->next(); // 次の要素へ移動
46        $count++;
47    }
48
49    echo "\nデモンストレーション終了。\n";
50    echo "ご覧のように、InfiniteIterator::valid() はイテレータが「有効な状態」であるかを検証し続け、常に true を返します。\n";
51    echo "このため、InfiniteIterator を使用する際は、無限ループを避けるための独自の終了条件が必要です。\n";
52}
53
54// 関数を実行してデモンストレーションを開始
55demonstrateInfiniteIteratorValid();
56
57?>

InfiniteIterator::valid()メソッドは、PHPのイテレータが現在の位置で有効な要素を提供できるかどうかをチェックするものです。このメソッドは引数を取らず、戻り値として真偽値（trueまたはfalse）を返します。trueはイテレータが有効な要素を指していることを意味し、falseは有効な要素がない、つまりイテレータの終わりに達したことを意味します。

特にInfiniteIteratorは、内部に持つイテレータ（例えばArrayIteratorなど）の要素を使い切っても、その要素を最初から繰り返し提供し続ける特徴があります。そのため、InfiniteIterator::valid()は、原則として常にtrueを返します。これは、イテレータが無限に有効な状態を維持するためです。

サンプルコードでは、ArrayIteratorをInfiniteIteratorでラップし、valid()メソッドの挙動を確認しています。whileループ内でvalid()が常にtrueを返す様子が示されています。したがって、InfiniteIteratorを使用する際は、無限ループを防ぐために、ループ回数の制限などの独自の終了条件を設ける必要があることに注意してください。これにより、InfiniteIteratorの無限の特性を安全に扱うことができます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Demonstrates the usage of InfiniteIterator::valid() to check iterator state.
7 *
8 * This function illustrates how InfiniteIterator::valid() determines if the
9 * iterator is currently in a valid state to return an element. For InfiniteIterator,
10 * this typically remains true as long as the underlying iterator initially contains
11 * elements, as it loops indefinitely. It returns false if the underlying iterator
12 * was empty from the start.
13 */
14function demonstrateInfiniteIteratorValidation(): void
15{
16    // Scenario 1: InfiniteIterator with a non-empty underlying iterator.
17    echo "--- Scenario 1: Non-empty inner iterator ---\n";
18    $data = ['Item 1', 'Item 2', 'Item 3'];
19    $arrayIterator = new ArrayIterator($data);
20    $infiniteIterator = new InfiniteIterator($arrayIterator);
21
22    $iterations = 0;
23    $maxIterations = 5; // Limit iterations for demonstration purposes.
24
25    // Loop while the iterator is valid and we haven't exceeded our demo limit.
26    // InfiniteIterator::valid() will be true here as it loops over existing items.
27    while ($infiniteIterator->valid() && $iterations < $maxIterations) {
28        $currentElement = $infiniteIterator->current();
29        echo sprintf(
30            "Current element: %s (Iterator valid: %s)\n",
31            $currentElement,
32            $infiniteIterator->valid() ? 'true' : 'false'
33        );
34        $infiniteIterator->next(); // Move to the next element (or loop back).
35        $iterations++;
36    }
37    echo "\nIteration stopped after $maxIterations cycles. InfiniteIterator::valid() is still " .
38         ($infiniteIterator->valid() ? 'true' : 'false') . " (will continue if not stopped).\n\n";
39
40    // Scenario 2: InfiniteIterator with an initially empty underlying iterator.
41    echo "--- Scenario 2: Initially empty inner iterator ---\n";
42    $emptyData = [];
43    $emptyArrayIterator = new ArrayIterator($emptyData);
44    $emptyInfiniteIterator = new InfiniteIterator($emptyArrayIterator);
45
46    // For an empty inner iterator, InfiniteIterator::valid() will immediately
47    // return false because there are no elements to iterate over, even infinitely.
48    echo sprintf(
49        "Is empty InfiniteIterator valid? %s\n",
50        $emptyInfiniteIterator->valid() ? 'true' : 'false'
51    );
52}
53
54// Execute the demonstration function.
55demonstrateInfiniteIteratorValidation();
56

PHP 8のInfiniteIteratorクラスに属するvalid()メソッドは、現在イテレータが有効な位置にあり、要素を取得できる状態であるかを判断します。このメソッドは引数を取らず、真偽値（trueまたはfalse）を返します。

InfiniteIteratorは、内部のイテレータ（元のイテレータ）が持つ要素を、終わりに達すると最初に戻って無限に繰り返し提供する特性があります。そのため、元のイテレータに一つでも要素がある場合、InfiniteIterator::valid()は常にtrueを返します。これは、イテレータが有効な要素を継続的に提供し続けることを意味します。

しかし、元のイテレータが最初から空だった場合、InfiniteIteratorには取得すべき要素が存在しないため、valid()メソッドはすぐにfalseを返します。サンプルコードでは、要素を持つイテレータではvalid()が常にtrueとなり、要素が空のイテレータではvalid()がfalseとなる挙動を通じて、この違いが明確に示されています。