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

Copy
1<?php
2
3/**
4 * LimitIterator::valid() の使用例を示すクラス
5 *
6 * このサンプルは、イテレータの特定範囲をループ処理する際に、
7 * valid() メソッドが現在の位置が有効かどうかを検証する様子を示します。
8 */
9class IteratorValidationExample
10{
11    /**
12     * サンプルコードを実行します。
13     *
14     * @return void
15     */
16    public static function run(): void
17    {
18        // 1. 元となるデータ配列を準備します。
19        $items = ['A', 'B', 'C', 'D', 'E', 'F', 'G'];
20
21        // 2. 配列をイテレートできる ArrayIterator オブジェクトに変換します。
22        $arrayIterator = new ArrayIterator($items);
23
24        // 3. LimitIterator を作成し、処理範囲を制限します。
25        // オフセット: 2 (3番目の要素 'C' から開始)
26        // リミット: 3 (最大3つの要素を取得)
27        $limitIterator = new LimitIterator($arrayIterator, 2, 3);
28
29        echo "指定範囲 (オフセット:2, リミット:3) の有効な要素:" . PHP_EOL;
30
31        // 4. while ループでイテレータを処理します。
32        // LimitIterator::valid() は、現在のイテレータの位置が指定した範囲内で有効な場合に
33        // true を返します。範囲外になると false を返し、ループが終了します。
34        // これが「イテレーション位置の検証 (validation)」の役割を果たします。
35        while ($limitIterator->valid()) {
36            // 有効な場合、現在のキーと値を出力
37            printf(
38                "キー: %s, 値: %s (valid() は true を返しました)\n",
39                $limitIterator->key(),
40                $limitIterator->current()
41            );
42
43            // 次の要素へ移動
44            $limitIterator->next();
45        }
46
47        echo "\nループが終了しました。" . PHP_EOL;
48
49        // ループ終了後、現在の位置は無効になっているため valid() は false を返します。
50        echo "現在の valid() の返り値: ";
51        var_dump($limitIterator->valid());
52    }
53}
54
55// クラスのメソッドを実行してサンプルを開始します。
56IteratorValidationExample::run();

PHPのLimitIterator::valid()メソッドは、イテレータの現在の位置が、LimitIteratorで定められた範囲内で有効かどうかを判定するために使用されます。このメソッドは、ループ処理が正しく範囲内でのみ実行されることを保証する、一種の検証（validation）の役割を担います。

このメソッドに引数はありません。戻り値は真偽値（bool）で、現在のイテレータの位置が有効な範囲にあればtrueを、範囲外であればfalseを返します。

サンプルコードでは、7つの要素を持つ配列の中から、オフセット2（3番目の要素'C'）から3つ分の範囲を指定してLimitIteratorを作成しています。whileループの条件式に$limitIterator->valid()が使われており、イテレータが有効な範囲（'C', 'D', 'E'）を指している間はtrueを返すためループが継続します。イテレータが範囲の最後の要素'E'の次に進むと、その位置は無効になるためvalid()はfalseを返し、ループが適切に終了します。このように、valid()メソッドは指定された範囲だけを安全に処理する上で不可欠な機能です。

Copy
1<?php
2
3/**
4 * LimitIterator::valid() の動作を示すサンプル関数
5 *
6 * LimitIteratorは、既存のイテレータの一部分だけを反復処理するためのものです。
7 * valid()メソッドは、イテレータの現在の位置が有効な要素を指しているかどうかを検証（validate）します。
8 * foreachループでは内部的に自動で呼び出されますが、ここではwhileループを使って
9 * どのように動作するかを明示的に示します。
10 */
11function demonstrateLimitIteratorValid(): void
12{
13    // 1. 元となるデータ配列を作成
14    $fruits = [
15        'apple',
16        'banana',
17        'cherry',
18        'dragon fruit',
19        'elderberry',
20    ];
21
22    // 2. 配列を反復処理できるようにArrayIteratorを作成
23    $arrayIterator = new ArrayIterator($fruits);
24
25    // 3. ArrayIteratorをLimitIteratorでラップし、範囲を限定する
26    //    オフセット1（2番目の要素 'banana'）から3つの要素を取得
27    $limitIterator = new LimitIterator($arrayIterator, 1, 3);
28
29    // 4. whileループを使って、LimitIteratorを明示的に操作する
30    //    イテレータを最初の位置（この場合は 'banana'）に戻す
31    $limitIterator->rewind();
32
33    echo "指定範囲の要素をループ処理します:" . PHP_EOL;
34
35    // valid()メソッドがtrueを返す間、ループを続ける
36    // このメソッドがイテレータのループ継続条件の「バリデーター」として機能する
37    while ($limitIterator->valid()) {
38        // 現在のキーと値を取得して表示
39        printf(
40            "キー: %s, 値: %s" . PHP_EOL,
41            $limitIterator->key(),
42            $limitIterator->current()
43        );
44
45        // 次の要素へ進む
46        $limitIterator->next();
47    }
48
49    echo "ループが終了しました。" . PHP_EOL;
50}
51
52// 関数を実行して結果を表示
53demonstrateLimitIteratorValid();

LimitIterator::valid()メソッドは、イテレータの現在の位置が有効な要素を指しているかどうかを検証するためのものです。ループ処理を続けるべきか判断する「バリデーター」として機能します。

このサンプルコードでは、まずLimitIteratorを使い、配列の2番目の要素から3つ分のデータ（'banana', 'cherry', 'dragon fruit'）だけを反復処理の対象としています。

whileループの条件式で$limitIterator->valid()が呼び出されています。イテレータが範囲内の有効な要素を指している間、valid()メソッドはtrueを返します。そのため、ループは継続され、現在のキーと値が表示されます。ループ内でnext()が実行されてイテレータが次の要素へ進み、指定した3つの要素の範囲を超えた時点で、valid()メソッドはfalseを返すようになります。これによりwhileループは終了します。

このメソッドは引数を取りません。戻り値は真偽値（bool）で、現在の位置が有効であればtrueを、範囲外などで無効であればfalseを返します。foreach文では内部的に利用されますが、このようにwhile文で使うと動作を明確に理解できます。