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

Copy
1<?php
2
3/**
4 * RegexIterator::setMode の使用例を示す関数です。
5 * システムエンジニアを目指す初心者が、正規表現でイテレータをフィルタリングし、
6 * 結果の取得モードを変更する方法を理解するのに役立ちます。
7 */
8function demonstrateRegexIteratorSetMode(): void
9{
10    // 処理対象となるデータ（様々なフルーツの名前の配列）を準備します。
11    // ArrayIterator はPHPの組み込みクラスで、配列をイテレータとして扱えるようにします。
12    $fruits = new ArrayIterator([
13        'apple',
14        'banana',
15        'grape',
16        'apricot',
17        'blueberry',
18        'cherry',
19        'avocado',
20    ]);
21
22    // RegexIterator をインスタンス化します。
23    // これは元のイテレータ ($fruits) をラップし、正規表現で要素をフィルタリングします。
24    // '/^a/i' は「a」で始まる文字列にマッチする正規表現です (i は大文字小文字を区別しないオプション)。
25    $regexIterator = new RegexIterator($fruits, '/^a/i');
26
27    echo "--- RegexIterator::MATCH (デフォルトモード) ---" . PHP_EOL;
28    echo "このモードでは、正規表現にマッチした元の要素全体がそのまま返されます。" . PHP_EOL;
29    // setMode を呼び出さない場合、RegexIterator::MATCH がデフォルトです。
30    // 明示的に設定することも可能です。
31    $regexIterator->setMode(RegexIterator::MATCH);
32    foreach ($regexIterator as $fruit) {
33        echo "- " . $fruit . PHP_EOL;
34    }
35    echo PHP_EOL;
36
37    echo "--- RegexIterator::GET_MATCH ---" . PHP_EOL;
38    echo "このモードでは、マッチした文字列全体と、正規表現内のキャプチャグループが配列で返されます。" . PHP_EOL;
39    // 今回の正規表現 '/^a/i' にはキャプチャグループがないため、
40    // 返される配列の要素0に全体のマッチ結果が格納されます。
41    // 例: 正規表現を '/^(a|b)/i' とすると、$match[1] には 'a' または 'b' が入ります。
42    $regexIterator->setMode(RegexIterator::GET_MATCH);
43    foreach ($regexIterator as $match) {
44        // $match は配列で、インデックス0に全体のマッチ結果が入ります。
45        echo "- Matched: " . $match[0] . PHP_EOL;
46    }
47    echo PHP_EOL;
48
49    echo "--- RegexIterator::ALL_MATCHES ---" . PHP_EOL;
50    echo "このモードでは、正規表現にマッチしたすべての部分（複数回マッチも含む）が配列の配列で返されます。" . PHP_EOL;
51    // setMode を RegexIterator::ALL_MATCHES に設定します。
52    // 各イテレータ項目に対して、preg_match_all() と同様の結果が返されます。
53    // 単一のマッチの場合はGET_MATCHと似た出力になりますが、複数のマッチがある場合に真価を発揮します。
54    $regexIterator->setMode(RegexIterator::ALL_MATCHES);
55    foreach ($regexIterator as $allMatches) {
56        // $allMatches[0] にはマッチした文字列全体が配列として格納されます。
57        echo "- All Matches: " . implode(', ', $allMatches[0]) . PHP_EOL;
58    }
59    echo PHP_EOL;
60
61    // RegexIterator::ALL_MATCHES のより実践的な例として、
62    // 1つの文字列から複数の数字をすべて抽出するケースを見てみましょう。
63    $dataWithNumbers = new ArrayIterator([
64        'item123_abc_45',
65        'data_678def90',
66        'no_numbers_here',
67    ]);
68    // 数字の並び（1つ以上）にマッチする正規表現です。
69    $regexIteratorNumbers = new RegexIterator($dataWithNumbers, '/\d+/');
70
71    echo "--- RegexIterator::ALL_MATCHES (1つの項目から複数のマッチを抽出) ---" . PHP_EOL;
72    echo "元の文字列から、含まれるすべての数字の並びを抽出します。" . PHP_EOL;
73    $regexIteratorNumbers->setMode(RegexIterator::ALL_MATCHES);
74    foreach ($regexIteratorNumbers as $allMatchesForOneItem) {
75        echo "- Found numbers: ";
76        // $allMatchesForOneItem[0] には、その項目で見つかったすべての全体マッチが格納されます。
77        if (!empty($allMatchesForOneItem[0])) {
78            echo implode(', ', $allMatchesForOneItem[0]) . PHP_EOL;
79        } else {
80            echo "None" . PHP_EOL;
81        }
82    }
83    echo PHP_EOL;
84}
85
86// 上記の関数を実行して、RegexIterator::setMode の動作を確認します。
87demonstrateRegexIteratorSetMode();

PHP 8のRegexIterator::setModeメソッドは、RegexIteratorクラスが正規表現を用いてイテレータから要素をフィルタリングする際、取得するデータの形式を定義するものです。引数として整数型の$modeを取り、これはRegexIteratorクラスが用意する定数（例えばRegexIterator::MATCHなど）で指定します。このメソッド自体は何も値を返しません。

サンプルコードでは、フルーツ名のリストをArrayIteratorで処理し、RegexIteratorで「a」から始まる名前を抽出しています。 最初にRegexIterator::MATCHモードを使うと、正規表現にマッチした元の要素全体がそのまま取得されます。これがデフォルトの動作です。 次にRegexIterator::GET_MATCHモードを設定すると、マッチした文字列全体が配列の0番目の要素に、正規表現にキャプチャグループがある場合はその内容も配列として取得できます。 最後にRegexIterator::ALL_MATCHESモードでは、元の要素内で正規表現に複数回マッチする可能性がある場合でも、そのすべてを配列の配列として取得します。コードの後半では、1つの文字列から複数の数字をすべて抽出する例を通して、このモードの柔軟性を示しています。このようにsetModeを利用することで、正規表現による高度なフィルタリングを行いながら、プログラムの目的に応じて取得するデータの形式を細かく調整することが可能になります。

Copy
1<?php
2
3/**
4 * RegexIterator::setModeの使用例
5 *
6 * この関数は、RegexIterator を使用して文字列の配列をフィルタリングし、
7 * setMode メソッドで異なるフィルタリングモードを設定する方法を示します。
8 *
9 * RegexIterator::setMode は、イテレータがどのように正規表現を適用し、
10 * 何を返すかを制御します。キーワード「date」に関連付けるため、日付に関連する
11 * 文字列をフィルタリングする例を使用します。
12 *
13 * @param array $data フィルタリングする文字列の配列。
14 * @param string $pattern 適用する正規表現パターン。
15 */
16function demonstrateRegexIteratorSetMode(array $data, string $pattern): void
17{
18    // ArrayIterator を使用して、配列をイテレータとして扱います。
19    $arrayIterator = new ArrayIterator($data);
20
21    // RegexIterator を作成し、正規表現パターンを設定します。
22    $regexIterator = new RegexIterator($arrayIterator, $pattern);
23
24    echo "--- デフォルトモード (RegexIterator::MATCH) ---" . PHP_EOL;
25    // デフォルトモードでは、正規表現にマッチする要素全体が返されます。
26    // setMode は明示的に呼び出さなくてもデフォルトは MATCH ですが、例として明示的に設定します。
27    $regexIterator->setMode(RegexIterator::MATCH);
28    foreach ($regexIterator as $key => $value) {
29        echo "キー: " . $key . ", 値: " . $value . PHP_EOL;
30    }
31    echo PHP_EOL;
32
33    // イテレータをリセットして、別のモードを試します。
34    $regexIterator->rewind();
35
36    echo "--- マッチしない要素を返すモード (RegexIterator::INVERT_MATCH) ---" . PHP_EOL;
37    // RegexIterator::INVERT_MATCH を設定すると、正規表現にマッチしない要素が返されます。
38    $regexIterator->setMode(RegexIterator::INVERT_MATCH);
39    foreach ($regexIterator as $key => $value) {
40        echo "キー: " . $key . ", 値: " . $value . PHP_EOL;
41    }
42    echo PHP_EOL;
43
44    // イテレータをリセットして、さらに別のモードを試します。
45    $regexIterator->rewind();
46
47    echo "--- マッチした部分を返すモード (RegexIterator::GET_MATCH) ---" . PHP_EOL;
48    // RegexIterator::GET_MATCH を設定すると、マッチした部分が配列として返されます。
49    // 通常、マッチ全体と、キャプチャグループがあればその内容が含まれます。
50    $regexIterator->setMode(RegexIterator::GET_MATCH);
51    foreach ($regexIterator as $key => $value) {
52        // $value は配列なので、implodeで文字列に変換して表示します。
53        echo "キー: " . $key . ", マッチした部分: [" . implode(', ', $value) . "]" . PHP_EOL;
54    }
55    echo PHP_EOL;
56}
57
58// サンプルデータ: さまざまな文字列の配列
59$strings = [
60    "Today's date is 2023-10-26.",
61    "Apple pie is delicious.",
62    "Meeting set for next Tuesday.",
63    "Plan a date night.",
64    "This is a random string.",
65    "Updating data records.",
66    "Another date entry here.",
67];
68
69// 正規表現パターン: 「date」という単語（大文字小文字を区別せず、単語の境界でマッチ）に一致するパターン
70// キーワード「php setdate」の「date」部分に焦点を当てています。
71$pattern = '/\bdate\b/i';
72
73// 関数を実行し、RegexIterator::setMode の動作を確認します。
74demonstrateRegexIteratorSetMode($strings, $pattern);
75
76?>

PHPのRegexIteratorクラスに属するsetModeメソッドは、正規表現を使ってデータをフィルタリングする際の動作を細かく制御するために利用されます。このメソッドはint $modeという整数型の引数を受け取り、イテレータが正規表現をどのように適用し、その結果として何を返すかを指定します。このメソッド自体は戻り値を返しません。

サンプルコードでは、RegexIterator::setModeの挙動を理解するため、文字列の配列から「date」というキーワードを含む要素をフィルタリングする具体例が示されています。これは、キーワード「php setdate」の「date」に着目し、日付に関連する情報を選び出す場面を想定したものです。

コードでは、主に三つの異なるモードを設定しています。一つ目のRegexIterator::MATCHモードは、正規表現パターンに完全に一致する元の文字列の要素全体を結果として返します。これがRegexIteratorの基本的な動作です。次に、RegexIterator::INVERT_MATCHモードでは、先のモードとは反対に、正規表現パターンに一致しない要素だけを結果として取得できます。そして、RegexIterator::GET_MATCHモードを設定すると、マッチした文字列の具体的な部分（正規表現の全体マッチや、括弧で指定したキャプチャグループの内容）が配列形式で返されます。

このようにsetModeメソッドを用いることで、データの集合から正規表現を使って特定の情報を抽出する際に、元の要素全体が必要なのか、一致しないものが欲しいのか、あるいはマッチした部分だけが必要なのかといった、多様な要件に応じてフィルタリングの振る舞いを柔軟に調整できる点が特徴です。