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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * RegexIterator::setFlags の使用例。
7 * SPLFileObject と組み合わせて、ファイルの行を正規表現でフィルタリングし、
8 * フラグによって取得する結果を変更する方法を示します。
9 *
10 * この例では、ファイル内の数値（整数または小数）を検索し、
11 * setFlags() メソッドを使ってマッチした結果の形式を制御します。
12 */
13function demonstrateRegexIteratorSetFlags(): void
14{
15    // 一時ファイルを作成し、テストデータを書き込みます。
16    // このファイルはスクリプト終了時に自動的に削除されます。
17    $tempFile = tempnam(sys_get_temp_dir(), 'regex_example_');
18    if ($tempFile === false) {
19        echo "一時ファイルの作成に失敗しました。\n";
20        return;
21    }
22
23    $content = <<<EOT
24Product-A: Price 100 USD
25Product-B: Discount 25.50 EUR
26No price information available.
27Product-C: Cost 50 JPY
28Product-D: Value 123.45 GBP
29EOT;
30    file_put_contents($tempFile, $content);
31
32    try {
33        // SPLFileObject を使用してファイルを開きます。
34        // READ_AHEAD: 読み取り中に次の行を先読みし、パフォーマンスを向上させます。
35        // SKIP_EMPTY: 空行をスキップします。
36        // DROP_NEW_LINE: 各行の末尾の改行文字を削除します。
37        $file = new \SPLFileObject($tempFile);
38        $file->setFlags(\SPLFileObject::READ_AHEAD | \SPLFileObject::SKIP_EMPTY | \SPLFileObject::DROP_NEW_LINE);
39
40        // 正規表現を定義します。行内の数値（整数部と小数部）を検索します。
41        // キャプチャグループ $1: 整数部分 (\d+)
42        // キャプチャグループ $2: 小数部分 (\.\d+)? - オプションでドットとそれに続く数字
43        $regex = '/(\d+)(\.\d+)?/';
44
45        echo "--- RegexIterator::setFlagsなし (デフォルト: MATCH) の場合 ---\n";
46        echo "  (正規表現にマッチする行全体が返されます)\n";
47        $regexIteratorDefault = new \RegexIterator($file, $regex);
48        foreach ($regexIteratorDefault as $line) {
49            echo "  マッチした行: " . $line . "\n";
50        }
51        echo "\n";
52
53        // RegexIterator を SPLFileObject と正規表現で初期化します。
54        echo "--- RegexIterator::setFlags(\\RegexIterator::GET_MATCH) の場合 ---\n";
55        echo "  (正規表現にマッチした部分文字列とキャプチャグループが配列として返されます)\n";
56        $regexIterator = new \RegexIterator($file, $regex);
57
58        // setFlags() メソッドを使用してフラグを設定します。
59        // GET_MATCH フラグを設定すると、イテレータはマッチした結果の配列を返します。
60        // この配列は preg_match() が返す形式と同じです。
61        // $match[0] には完全なマッチ文字列、それ以降のインデックスにはキャプチャグループが格納されます。
62        $regexIterator->setFlags(\RegexIterator::GET_MATCH);
63
64        foreach ($regexIterator as $match) {
65            // GET_MATCH フラグが設定されている場合、$match はマッチ結果の配列となります。
66            // $match[0] は正規表現全体にマッチした文字列 (例: "100", "25.50")
67            // $match[1] は最初のキャプチャグループ (\d+) にマッチした文字列 (例: "100", "25")
68            // $match[2] は2番目のキャプチャグループ (\.\d+)? にマッチした文字列 (例: null, ".50")
69            $fullMatch = $match[0];
70            $integerPart = $match[1] ?? 'N/A'; // 存在しない場合は 'N/A'
71            $decimalPart = $match[2] ?? 'N/A'; // 存在しない場合は 'N/A'
72            echo "  完全なマッチ: {$fullMatch}, 整数部: {$integerPart}, 小数部: {$decimalPart}\n";
73        }
74        echo "\n";
75
76    } finally {
77        // 使用した一時ファイルを削除します。
78        if (file_exists($tempFile)) {
79            unlink($tempFile);
80        }
81    }
82}
83
84// 関数を実行して、RegexIterator::setFlags の動作を確認します。
85demonstrateRegexIteratorSetFlags();
86

PHPのRegexIterator::setFlagsメソッドは、RegexIteratorオブジェクトが正規表現を使って反復処理を行う際の振る舞いを変更するために使われます。このメソッドは、int $flagsという整数型の引数を一つ受け取ります。この$flagsには、RegexIteratorクラスで定義されている様々な定数を指定することで、イテレータの動作を設定します。このメソッド自体は、値を返しません（戻り値なし）。

サンプルコードでは、まずSPLFileObjectを使ってファイルの内容を読み込み、その後RegexIteratorを用いてファイル内の数値にマッチする行を検索しています。setFlagsメソッドを使用しないデフォルトの状態では、正規表現にマッチした「行全体」が取得されます。

一方、$regexIterator->setFlags(\RegexIterator::GET_MATCH);のようにGET_MATCHフラグを設定すると、イテレータの動作が変更されます。このフラグを設定することで、イテレータはマッチした行全体ではなく、正規表現にマッチした「部分文字列」と、正規表現内のキャプチャグループにマッチした内容を「配列」として返します。配列の最初の要素（$match[0]）には完全なマッチ文字列が、続く要素（$match[1], $match[2]など）にはキャプチャグループにマッチした部分が格納され、より詳細な情報抽出が可能になります。

このように、setFlagsメソッドを利用することで、正規表現によるフィルタリング結果を柔軟に制御し、必要なデータを効率的に取得できるようになります。