【PHP8.x】validメソッドの使い方

validメソッドは、イテレータの現在の位置が有効かどうかをチェックするメソッドです。このメソッドは、RegexIteratorオブジェクトが内部で保持しているイテレータを繰り返し処理する際に、現在の要素が処理対象として妥当であるかを判定します。具体的には、元のイテレータの現在の位置が有効であり、かつ、その要素がRegexIteratorのコンストラクタで指定された正規表現パターンにマッチする場合にtrueを返します。一方で、元のイテレータがすでに終端に達している場合や、現在の要素が正規表現にマッチしない場合にはfalseを返します。通常、このメソッドはforeachループの内部で自動的に呼び出され、ループを継続するかどうかを決定するために利用されます。プログラマが直接呼び出すことも可能で、その場合は現在のイテレーションが有効な状態にあるかを確認できます。このメソッドはPHPの標準インターフェースであるIteratorの一部として定義されており、反復処理可能なオブジェクトを正しく実装するために不可欠な役割を担っています。

Copy
1<?php
2
3// 対象の配列データ
4$data = new ArrayObject(['test1', 'test2', 'foo', 'test3']);
5
6// ArrayObjectからイテレータを取得
7$iterator = $data->getIterator();
8
9// "test"で始まる文字列にマッチするRegexIteratorを作成
10$regexIterator = new RegexIterator($iterator, '/^test/');
11
12// イテレータを先頭に戻す
13$regexIterator->rewind();
14
15// valid()メソッドで、イテレータが有効な位置にあるかを確認
16while ($regexIterator->valid()) {
17    // 有効な場合、現在のキーと値を出力
18    echo $regexIterator->key() . ' => ' . $regexIterator->current() . PHP_EOL;
19
20    // イテレータを次の要素に進める
21    $regexIterator->next();
22}
23
24?>

引数なし

引数はありません

bool

現在のイテレータが有効な要素を指しているかどうかを示す真偽値を返します。要素が存在しない場合は false を返します。