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

Copy
1<?php
2
3/**
4 * 特定の条件を満たす要素のみを通過させるフィルタクラス。
5 * この例では、偶数のみを有効なデータとして検証（バリデーション）します。
6 */
7class EvenNumberFilter extends FilterIterator
8{
9    /**
10     * 現在の要素がイテレーションで有効かどうかを判断します。
11     * FilterIteratorでは、このaccept()メソッドが実質的なバリデーションルールを定義します。
12     *
13     * @return bool 現在の要素が偶数の場合は true、そうでない場合は false を返します。
14     */
15    public function accept(): bool
16    {
17        // current() で現在の要素の値を取得し、それが偶数かどうかを検証します。
18        $currentValue = $this->current();
19        return is_int($currentValue) && $currentValue % 2 === 0;
20    }
21}
22
23// 1. 元となるデータ配列
24$numbers = [1, 2, 'text', 3, 4, 5, 6, 7, 8, '9', 10];
25
26// 2. 配列をイテレータに変換
27$arrayIterator = new ArrayIterator($numbers);
28
29// 3. カスタムフィルタを適用したイテレータを作成
30$filterIterator = new EvenNumberFilter($arrayIterator);
31
32// 4. ループ処理
33// FilterIterator::valid() は、フィルタリング後の結果として
34// 有効な要素がまだ存在するかどうかをチェックします。
35// accept() が true を返す要素がなくなるまで、ループは続行されます。
36echo "フィルタリング（検証）後の有効な数値（偶数）:" . PHP_EOL;
37foreach ($filterIterator as $key => $value) {
38    echo "[{$key}] => {$value}" . PHP_EOL;
39}

PHPのFilterIterator::valid()メソッドは、フィルタリング後のイテレータに、処理すべき有効な要素がまだ残っているかどうかを判定するために使われます。主にforeachループなどでPHPの内部的に呼び出され、ループを続けるか終了するかを決定する役割を持ちます。

このメソッドに引数はありません。戻り値は真偽値（bool）です。イテレータ内にフィルタリング条件を満たす有効な要素がまだ存在する場合はtrueを、もう存在しない場合はfalseを返します。

サンプルコードでは、配列から偶数のみを抽出（検証）するためのカスタムフィルタEvenNumberFilterを定義しています。具体的な検証ルールはaccept()メソッドに実装されており、現在の要素が整数かつ偶数の場合にtrueを返します。foreachループでこのフィルタ済みイテレータを処理する際、内部でvalid()が呼び出されます。valid()はaccept()がtrueを返す要素が見つかるまでイテレータを次に進め、見つかればtrueを返してループ処理を続行します。全ての要素を確認し、有効な要素がなくなるとfalseを返し、ループが終了します。このようにvalid()は、定義した検証ルールに従って、有効なデータだけを効率的に処理するために不可欠なメソッドです。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 偶数のみを有効とするカスタムイテレータ。
7 *
8 * FilterIteratorを継承することで、既存のイテレータ(この例ではArrayIterator)の
9 * 要素を特定の条件でフィルタリング（検証）できます。
10 */
11class EvenNumberValidator extends FilterIterator
12{
13    /**
14     * このメソッドで、現在の要素が有効かどうかを判定します。
15     * true を返した要素のみが、イテレーションの対象となります。
16     *
17     * @return bool 現在の要素が偶数なら true、そうでなければ false
18     */
19    public function accept(): bool
20    {
21        // 親イテレータから現在の値を取得
22        $current = $this->current();
23        
24        // 値が整数かつ偶数であるかを検証
25        return is_int($current) && $current % 2 === 0;
26    }
27}
28
29// 検証対象のデータ
30$numbers = [1, 2, 'text', 4, 5, 6, 8, 9.5, 10];
31
32// 配列をイテレート可能にするためにArrayIteratorを使用
33$iterator = new ArrayIterator($numbers);
34
35// 作成したカスタムフィルタ（バリデータ）を適用
36$evenIterator = new EvenNumberValidator($iterator);
37
38// foreach ループでイテレータを処理
39// ループの各繰り返しで、内部的に valid() メソッドが呼び出され、
40// 有効な要素がまだ存在するか（accept()がtrueを返す要素があるか）がチェックされます。
41// valid() が false を返した時点でループは終了します。
42foreach ($evenIterator as $key => $value) {
43    echo "Key: {$key}, Valid Value: {$value}" . PHP_EOL;
44}
45
46?>

PHPのFilterIterator::valid()メソッドは、イテレータの現在の位置に、フィルタ条件を満たす有効な要素が存在するかどうかを確認します。このメソッドは引数を持たず、戻り値としてbool型（trueまたはfalse）を返します。

foreach文などでイテレータを処理する際、ループの各繰り返しが始まる前にこのvalid()メソッドが内部的に呼び出されます。戻り値がtrueの間はループが継続し、falseになると有効な要素はもう存在しないと判断され、ループが終了します。

サンプルコードでは、配列から偶数のみを取り出すカスタムイテレータEvenNumberValidatorを定義しています。foreachループがこのイテレータを処理する際、valid()メソッドは、accept()メソッドで定義された「整数かつ偶数である」という条件を満たす次の要素を探します。条件に合う要素が見つかればtrueを返し、その要素がループ内で処理されます。全ての要素を確認し、条件に合うものがなくなるとfalseを返し、ループは停止します。このようにvalid()は、フィルタリングを伴う繰り返し処理の制御に不可欠な役割を担っています。