【PHP8.x】mb_ereg_search_getregs()関数の使い方

Copy
1<?php
2
3/**
4 * PHPのmb_ereg_match関数とmb_ereg_search_getregs関数の使用例を示します。
5 *
6 * mb_ereg_match: 文字列全体が正規表現パターンにマッチするかを判定します。
7 * mb_ereg_search_getregs: 最後に実行されたmb_ereg系の検索関数でキャプチャされた
8 *                        部分文字列の配列を取得します。
9 *                        mb_ereg_matchが成功した場合にのみ意味のある結果を返します。
10 */
11function demonstrateMbEregMatchAndGetRegsExample(): void
12{
13    // PHPのマルチバイト正規表現関数の内部エンコーディングを設定します。
14    // これにより、様々な文字セットで正しく正規表現が機能するようになります。
15    // PHP 8では通常 'UTF-8' がデフォルトですが、明示的な設定は良い習慣です。
16    mb_regex_encoding('UTF-8');
17
18    // --- 成功例 ---
19    echo "--- 成功例 ---" . PHP_EOL;
20
21    $text = "ユーザー名: Alice, ID: 007";
22    // 正規表現パターン:
23    // ^      : 文字列の先頭
24    // ([^,]+): 1つ目のキャプチャグループ。カンマ以外の文字が1回以上続く部分
25    // ([0-9]+): 2つ目のキャプチャグループ。数字が1回以上続く部分
26    // $      : 文字列の末尾
27    // mb_ereg_matchは文字列全体がパターンに一致する必要があるため、^と$で囲んでいます。
28    $pattern = '^ユーザー名: ([^,]+), ID: ([0-9]+)$';
29
30    echo "対象文字列: " . $text . PHP_EOL;
31    echo "正規表現パターン: " . $pattern . PHP_EOL . PHP_EOL;
32
33    // mb_ereg_matchを使って、文字列全体がパターンにマッチするか判定します。
34    // マッチした場合、trueを返します。
35    if (mb_ereg_match($pattern, $text)) {
36        echo "文字列は正規表現パターンに完全にマッチしました。" . PHP_EOL;
37
38        // mb_ereg_search_getregsは引数なしで、直前のマッチング結果を取得します。
39        // 戻り値は配列、またはマッチしなかった場合はfalse（ただし、このブロック内ではマッチしています）。
40        $matches = mb_ereg_search_getregs();
41
42        if ($matches !== false) {
43            echo "マッチした詳細情報:" . PHP_EOL;
44            // $matches[0] はパターン全体にマッチした文字列です。
45            echo "  [0] (全体マッチ): " . $matches[0] . PHP_EOL;
46            // $matches[1] は1番目のキャプチャグループにマッチした文字列です。
47            echo "  [1] (ユーザー名): " . $matches[1] . PHP_EOL;
48            // $matches[2] は2番目のキャプチャグループにマッチした文字列です。
49            echo "  [2] (ID): " . $matches[2] . PHP_EOL;
50        } else {
51            // このパスは通常通らないはずですが、エラーハンドリングとして記述します。
52            echo "エラー: mb_ereg_search_getregs が結果を取得できませんでした。" . PHP_EOL;
53        }
54    } else {
55        echo "文字列は正規表現パターンにマッチしませんでした。" . PHP_EOL;
56    }
57
58    echo PHP_EOL;
59
60    // --- 失敗例 ---
61    echo "--- 失敗例 ---" . PHP_EOL;
62
63    $text_no_match = "ユーザー名: Bob"; // IDがないためパターン全体にマッチしない
64    echo "対象文字列: " . $text_no_match . PHP_EOL;
65    echo "正規表現パターン: " . $pattern . PHP_EOL . PHP_EOL;
66
67    // mb_ereg_matchはパターンにマッチしないため、falseを返します。
68    if (mb_ereg_match($pattern, $text_no_match)) {
69        echo "文字列は正規表現パターンに完全にマッチしました。" . PHP_EOL;
70        // マッチしないため、このブロックは実行されません。
71    } else {
72        echo "文字列は正規表現パターンにマッチしませんでした。" . PHP_EOL;
73        // マッチしない場合、mb_ereg_search_getregsを呼び出しても意味のある結果は得られません。
74        // 以前のマッチ結果が残っている可能性があるので注意が必要です。
75        echo "マッチしない場合、mb_ereg_search_getregsは使用すべきではありません。" . PHP_EOL;
76    }
77}
78
79// 関数を実行して、サンプルコードの動作を確認します。
80demonstrateMbEregMatchAndGetRegsExample();
81
82?>

PHP 8で提供されるmb_ereg_search_getregs関数は、直前に実行されたmb_ereg系の正規表現検索関数（例えばmb_ereg_match）が成功した場合に、マッチした文字列の具体的な部分を配列として取得する機能を提供します。この関数は引数を取らず、最後に成功した正規表現マッチの結果を自動的に参照します。戻り値は、マッチした全体および正規表現内の括弧で囲まれたキャプチャグループの内容を含む配列です。もし直前の検索が失敗していた場合や、検索が行われていない場合はfalseを返しますが、通常はmb_ereg_matchがtrueを返した直後に呼び出すことで、期待通りの配列を得られます。

サンプルコードでは、まずmb_regex_encoding('UTF-8')でマルチバイト正規表現のエンコーディングを設定しています。その後、mb_ereg_matchを使って対象文字列全体が特定の正規表現パターンに完全に一致するかを判定しています。文字列がパターンにマッチすると、mb_ereg_search_getregsを呼び出すことで、パターン全体に一致した部分（配列の0番目）と、正規表現内のキャプチャグループに一致した部分（配列の1番目以降）を効率的に取得できる様子を示しています。これにより、例えば文字列からユーザー名やIDといった特定の情報を抽出することが可能になります。マッチしなかった場合はmb_ereg_search_getregsを呼び出しても意味のある結果は得られないため、mb_ereg_matchが成功した場合にのみ利用することが重要です。

Copy
1<?php
2
3/**
4 * mb_ereg_search_getregs 関数の使用例を示します。
5 * この関数は、mb_ereg_search_init および mb_ereg_search と組み合わせて使用し、
6 * 正規表現でマッチした文字列の各部分（キャプチャグループ）を取得します。
7 *
8 * システムエンジニアを目指す初心者の方にも理解しやすいように、
9 * メールアドレスからユーザー名とドメイン名を抽出する例で説明します。
10 */
11function demonstrateMbEregSearchGetregs(): void
12{
13    // マルチバイト正規表現のエンコーディングを設定します。
14    // 日本語などのマルチバイト文字を扱う場合に必須です。
15    mb_regex_encoding('UTF-8');
16
17    $text = "私のメールアドレスは user@example.com です。もう一つ test@domain.jp もあります。";
18    // メールアドレスを検索するための正規表現です。
19    // 丸括弧 () で囲まれた部分は「キャプチャグループ」と呼ばれ、
20    // マッチした文字列の特定の部分を個別に取得できるようになります。
21    // [0] は全体のマッチ、[1] は1番目のグループ、[2] は2番目のグループに対応します。
22    $pattern = '([a-zA-Z0-9._%+-]+)@([a-zA-Z0-9.-]+\.[a-zA-Z]{2,})';
23
24    echo "--- mb_ereg_search_getregs の使用例 ---" . PHP_EOL;
25    echo "検索対象の文字列: " . $text . PHP_EOL;
26    echo "使用する正規表現: " . $pattern . PHP_EOL . PHP_EOL;
27
28    // 検索対象の文字列を初期化し、mb_ereg_search_getregs が使う内部バッファにセットします。
29    mb_ereg_search_init($text);
30
31    $matchCount = 0;
32    // mb_ereg_search() は、指定されたパターンに一致する箇所を順次検索します。
33    // マッチが見つかると true を返し、見つからなくなると false を返します。
34    // ループの中で、mb_ereg_search_getregs() を使ってマッチした詳細情報を取得します。
35    while (mb_ereg_search($pattern)) {
36        // mb_ereg_search_getregs() は、直前の mb_ereg_search() で見つかった
37        // マッチ全体と、各キャプチャグループの文字列の配列を返します。
38        // マッチが見つからなかった場合やエラーが発生した場合は false を返します。
39        $matches = mb_ereg_search_getregs();
40
41        if ($matches !== false) {
42            $matchCount++;
43            echo "--- マッチ #" . $matchCount . " ---" . PHP_EOL;
44            echo "全体のマッチした文字列: " . ($matches[0] ?? 'N/A') . PHP_EOL; // 正規表現全体にマッチした部分
45            echo "ユーザー名 (グループ1): " . ($matches[1] ?? 'N/A') . PHP_EOL;   // 1番目のキャプチャグループ（メールアドレスのユーザー名部分）
46            echo "ドメイン名 (グループ2): " . ($matches[2] ?? 'N/A') . PHP_EOL;   // 2番目のキャプチャグループ（メールアドレスのドメイン名部分）
47            echo PHP_EOL;
48        } else {
49            // mb_ereg_search が true を返した後に mb_ereg_search_getregs が false を返すことは稀ですが、
50            // 念のためエラーハンドリングを含めています。
51            echo "エラー: mb_ereg_search_getregs() が false を返しました。" . PHP_EOL;
52            break; // エラー発生のためループを終了します。
53        }
54    }
55
56    if ($matchCount === 0) {
57        echo "指定された正規表現パターンに一致するメールアドレスは見つかりませんでした。" . PHP_EOL;
58    }
59
60    echo "--- 処理終了 ---" . PHP_EOL;
61}
62
63// 関数を実行して、サンプルコードの動作を確認します。
64demonstrateMbEregSearchGetregs();
65
66?>

PHPのmb_ereg_search_getregs関数は、マルチバイト対応の正規表現検索において、直前に見つかったマッチの詳細な情報を取得するために使用されます。この関数は単体で使うのではなく、まずmb_ereg_search_initで検索対象の文字列を初期化し、その後mb_ereg_searchで正規表現に一致する箇所が検出された直後に呼び出すことで機能します。

この関数は引数をとりません。戻り値は、マッチが見つかった場合は配列（array）となり、見つからなかった場合やエラー発生時にはfalseを返します。戻り値が配列の場合、その要素には正規表現全体にマッチした文字列と、正規表現で丸括弧()を使って指定された各部分（「キャプチャグループ」と呼ばれます）にマッチした文字列が含まれます。具体的には、配列の[0]番目には正規表現全体にマッチした部分、[1]番目には最初のキャプチャグループ、[2]番目には2番目のキャプチャグループといった形で格納されます。

サンプルコードでは、メールアドレスを検索し、ユーザー名とドメイン名をそれぞれキャプチャグループとして抽出する例を示しています。mb_ereg_search_getregsを利用することで、メールアドレス全体だけでなく、ユーザー名とドメイン名といった特定の部分を個別に取得し、後続の処理で活用することが可能になります。これにより、文字列の中から必要な情報を効率的に構造化して取り出すことができます。