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

Copy
1<?php
2
3// 1. 検証対象となる文字列データの配列を準備します。
4//    この例では、異なる形式のメールアドレスと無効な文字列を含んでいます。
5$dataList = [
6    'user1@example.com',
7    'admin@php.net',         // このメールアドレスはフィルタリング対象
8    'info@domain.co.jp',
9    'not-an-email-string',   // 無効な形式
10    'contact@example.com',
11    'support@php.net',       // このメールアドレスもフィルタリング対象
12    'invalid-email@',        // 無効な形式
13];
14
15// 2. ArrayIterator を使用して、配列をイテレータとして扱えるようにします。
16//    これにより、配列を反復処理するための標準的なインターフェースを提供します。
17$arrayIterator = new ArrayIterator($dataList);
18
19// 3. RegexIterator をインスタンス化し、ArrayIterator と正規表現を渡します。
20//    RegexIterator::valid() メソッドは、この正規表現に基づいて、
21//    現在の要素が条件にマッチするかどうか (有効かどうか) を判断します。
22//    ここでは、ドメインが "@php.net" であるメールアドレスにマッチする正規表現を設定します。
23//    RegexIterator::MATCH フラグは、正規表現にマッチした要素のみを返すように指定します。
24$regexIterator = new RegexIterator(
25    $arrayIterator,
26    '/^[^@]+@php\.net$/i', // ドメインが @php.net のメールアドレスにマッチする正規表現
27    RegexIterator::MATCH
28);
29
30echo "--- PHP.net ドメインの有効なメールアドレス一覧 ---\n";
31
32// 4. foreach ループを使って RegexIterator を反復処理します。
33//    このループの内部で、RegexIterator::valid() メソッドが自動的に呼び出され、
34//    現在の要素が上記の正規表現にマッチするかどうかを判断します。
35//    valid() が true を返した要素 (正規表現にマッチした要素) のみが、
36//    このループで処理され、画面に出力されます。
37foreach ($regexIterator as $email) {
38    echo "  - " . $email . "\n";
39}
40
41// RegexIterator::valid() メソッドの役割に関する補足:
42// このメソッドは、RegexIterator のイテレーション中に、現在の要素が
43// 指定された正規表現のフィルタリング条件を満たしているか (有効か) を
44// 真偽値 (true/false) で判定するために内部的に呼び出されます。
45// 開発者が直接呼び出すことは稀ですが、イテレータのフィルタリング機構の
46// 重要な部分を担っており、データ検証 (validation) のロジックを
47// イテレータに組み込む際に利用されます。

PHP 8のRegexIterator::valid()メソッドは、RegexIteratorクラスに属するメソッドで、現在のイテレータ要素が正規表現によるフィルタリング条件を満たしているか、つまり「有効」であるかを判定します。このメソッドは引数を取らず、条件を満たす場合はtrueを、満たさない場合はfalseを真偽値として返します。

通常、開発者がこのvalid()メソッドを直接呼び出すことはほとんどありません。RegexIteratorは、渡された正規表現に基づいてイテレータ内の要素を自動的にフィルタリングするためのクラスであり、foreachループなどでRegexIteratorを反復処理する際に、各要素が正規表現にマッチするかどうかを判断するために、内部的にvalid()メソッドが自動的に呼び出されます。

サンプルコードでは、メールアドレスの配列をArrayIteratorでラップした後、RegexIteratorをインスタンス化する際に、「@php.netドメインのメールアドレス」にマッチする正規表現を設定しています。この設定により、foreachループでregexIteratorを処理する際、RegexIterator::valid()が内部的に実行され、正規表現に合致する「有効な」メールアドレスのみが抽出され、画面に出力されます。このように、valid()メソッドは、データ検証（validation）のロジックをイテレータに組み込み、効率的なデータフィルタリングを可能にする重要な役割を果たしています。

Copy
1<?php
2
3/**
4 * RegexIterator::valid() メソッドの使用例
5 * 指定された文字列のリストから、正規表現にマッチする要素（＝有効な要素）のみを抽出します。
6 * RegexIterator::valid() は、現在の要素が正規表現にマッチし、かつイテレータが有効な位置にある場合に true を返します。
7 * これは特定のパターンに合致する「有効な」データを抽出する、一種のバリデーションとして機能します。
8 *
9 * @param array $data フィルタリングする文字列の配列。
10 * @param string $pattern 使用する正規表現パターン。
11 * @return array 正規表現にマッチした有効な文字列の配列。
12 */
13function filterValidStringsByPattern(array $data, string $pattern): array
14{
15    $validItems = [];
16
17    // 1. 元となる配列を ArrayIterator でラップします。
18    // ArrayIterator は配列をイテレータとして扱えるようにします。
19    $arrayIterator = new ArrayIterator($data);
20
21    // 2. RegexIterator を作成します。
22    // これにより、指定された正規表現パターンにマッチする要素のみを反復処理できます。
23    // RegexIterator::MATCH は、パターンにマッチする要素のみを返すように指定します。
24    $regexIterator = new RegexIterator($arrayIterator, $pattern, RegexIterator::MATCH);
25
26    // 3. while ループを使用して、イテレータの現在位置が有効である間、処理を続けます。
27    // RegexIterator::valid() は、内部イテレータが有効な位置にあり、
28    // かつ現在の要素がコンストラクタで指定された正規表現パターンにマッチする場合に true を返します。
29    while ($regexIterator->valid()) {
30        // 現在の有効な要素を取得し、結果配列に追加します。
31        $validItems[] = $regexIterator->current();
32
33        // 次の要素に進みます。
34        $regexIterator->next();
35    }
36
37    return $validItems;
38}
39
40// --- サンプルコード実行部分 ---
41
42// 処理するデータ: 様々な文字列が含まれています。
43$items = [
44    'apple',
45    'banana',
46    'grape',
47    'orange',
48    'pineapple',
49    'strawberry',
50    'kiwi',
51    'water'
52];
53
54// 特定のパターンを定義します（例: 'p' または 'a' を含む文字列）。
55// このパターンに合致する文字列が「有効」とみなされます。
56$pattern = '/[pa]/i'; // 'p' または 'a' を含む（大文字小文字を区別しない）
57
58echo "元のデータ: " . implode(', ', $items) . "\n";
59echo "正規表現パターン: " . $pattern . "\n";
60echo "--- RegexIterator::valid() を使ったフィルタリング結果 ---\n";
61
62// filterValidStringsByPattern 関数を呼び出して、フィルタリングされた有効な文字列を取得します。
63$filteredItems = filterValidStringsByPattern($items, $pattern);
64
65// フィルタリングされた結果を表示します。
66if (empty($filteredItems)) {
67    echo "該当するデータはありませんでした。\n";
68} else {
69    echo "有効なデータ: " . implode(', ', $filteredItems) . "\n";
70}
71

RegexIterator::valid()は、PHPのRegexIteratorクラスに属するメソッドです。このメソッドは引数を取らず、現在のイテレータ位置が有効であり、かつ現在の要素がRegexIteratorのコンストラクタで指定された正規表現パターンにマッチするかどうかを判定し、その結果を真偽値（trueまたはfalse）で返します。

具体的には、RegexIteratorを使って配列などのデータを反復処理する際に、whileループの条件として利用されます。例えば、サンプルコードではwhile ($regexIterator->valid())と記述することで、現在の要素が正規表現パターンに合致し、「有効なデータ」である間だけループ内の処理を継続します。

このメソッドの主な役割は、正規表現によるフィルタリングが適用されたイテレータにおいて、次に処理すべき要素が条件を満たしているかを継続的にチェックすることです。これにより、特定のパターンに合致する「有効な」データのみを抽出し、それ以外のデータをスキップするといったデータフィルタリングや、一種のデータ検証（バリデーション）のメカニズムとして機能します。結果として、指定された条件に合致する要素だけを効率的に取り扱うことができます。