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

Copy
1<?php
2
3/**
4 * 文字列内で指定された正規表現パターンの最初のマッチ位置を検索し、その結果を表示します。
5 * この関数は、mb_ereg_search_init() と mb_ereg_search() で検索を初期化・実行し、
6 * mb_ereg_search_pos() でマッチした部分の開始位置と長さを取得する流れを示します。
7 *
8 * @param string $text 検索対象の文字列。
9 * @param string $pattern 検索に使う正規表現パターン。
10 */
11function findPatternPosition(string $text, string $pattern): void
12{
13    // mb_ereg関数群の正規表現エンジンが使用するエンコーディングを設定します。
14    // マルチバイト文字を正しく扱うために重要です。通常は'UTF-8'が推奨されます。
15    // この設定がない場合、php.iniの 'mbstring.internal_encoding' が使用されます。
16    mb_regex_encoding('UTF-8');
17
18    // 検索対象の文字列を初期化します。
19    // これにより、以降の mb_ereg_search() や mb_ereg_search_pos() がこの文字列を対象とします。
20    mb_ereg_search_init($text);
21
22    // 指定されたパターンで文字列を検索します。
23    // マッチが見つかった場合、そのマッチした文字列の長さを返します（0を含む）。
24    // マッチが見つからない場合は false を返します。
25    if (mb_ereg_search($pattern)) {
26        // mb_ereg_search() でマッチが成功した場合、
27        // mb_ereg_search_pos() はそのマッチした部分の開始位置と長さを配列で返します。
28        // 例: array(開始位置, 長さ)
29        // マッチ情報が利用できない場合やエラーの場合は false を返します。
30        $pos = mb_ereg_search_pos();
31
32        if (is_array($pos)) {
33            echo "--- 検索結果 ---\n";
34            echo "検索パターン: '{$pattern}'\n";
35            echo "対象文字列: '{$text}'\n";
36            echo "  パターンが見つかりました。\n";
37            echo "  開始位置 (offset): {$pos[0]}\n";
38            echo "  長さ (length): {$pos[1]}\n";
39            // mb_substr を使用して、マッチした実際の文字列部分を抽出します。
40            echo "  マッチした部分: '" . mb_substr($text, $pos[0], $pos[1]) . "'\n";
41        } else {
42            // mb_ereg_search() が true を返したにもかかわらず mb_ereg_search_pos() が
43            // 位置を特定できないことは稀ですが、念のためエラーハンドリングを含めます。
44            echo "--- 検索結果 ---\n";
45            echo "検索パターン: '{$pattern}'\n";
46            echo "対象文字列: '{$text}'\n";
47            echo "  エラー: パターンはマッチしましたが、位置情報を取得できませんでした。\n";
48        }
49    } else {
50        // パターンが文字列内で見つからなかった場合。
51        echo "--- 検索結果 ---\n";
52        echo "検索パターン: '{$pattern}'\n";
53        echo "対象文字列: '{$text}'\n";
54        echo "  パターンは見つかりませんでした。\n";
55    }
56    echo "\n"; // 結果を見やすくするための改行
57}
58
59// --- サンプル実行 ---
60
61// 1. 基本的な文字列の検索（マッチするケース）
62findPatternPosition("こんにちは、PHPの世界へようこそ！", "PHP");
63
64// 2. 基本的な文字列の検索（マッチしないケース）
65findPatternPosition("Hello World", "Python");
66
67// 3. マルチバイト文字を含むパターンの検索
68findPatternPosition("吾輩は猫である。", "猫");
69
70// 4. 正規表現メタ文字を含むパターンの検索
71// `.` は任意の一文字にマッチします。
72findPatternPosition("abcde", "b.d");
73
74// 5. より複雑な正規表現パターン（メールアドレス形式の文字列全体を検索）
75findPatternPosition("user_name123@example.com", "[a-zA-Z0-9._-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}");

mb_ereg_search_pos関数は、mb_ereg_search_initで設定された文字列に対し、mb_ereg_searchで正規表現パターン検索を実行した際、マッチした部分の開始位置と長さを取得します。特に日本語のようなマルチバイト文字を含む文字列を正確に扱う必要がある場合に有用です。

サンプルコードでは、まずmb_regex_encodingで文字エンコーディングを'UTF-8'に設定し、mb_ereg_search_initで検索対象文字列を初期化しています。続いてmb_ereg_searchで指定したパターンを検索し、マッチが成功した場合にmb_ereg_search_posを呼び出しています。本関数は、直前のmb_ereg_searchの結果を利用するため、通常引数を省略して呼び出します。その際、引数$patternおよび$optionsはNULLとして扱われます。

戻り値は、マッチした部分の開始位置（0から始まるインデックス）と長さを示す2つの要素を持つ配列（例：[開始位置, 長さ]）です。もしマッチが見つからないか、検索情報が利用できない場合はfalseを返します。このサンプルコードは、検索対象文字列の初期化から正規表現パターンによる検索、そしてマッチ位置の特定までの一連の流れを示しており、マルチバイト文字を含む文字列の高度な検索処理に活用できます。

Copy
1<?php
2
3// 内部エンコーディングを設定することで、マルチバイト文字が正しく扱われるようにします。
4// これは日本語などのマルチバイト文字を正確に処理するために重要です。
5mb_internal_encoding("UTF-8");
6
7/**
8 * 指定されたテキストから正規表現に最初にマッチする箇所の開始位置と長さを検索し、結果を表示します。
9 *
10 * mb_ereg_search_pos 関数は、mb_ereg_search_init で設定された文字列に対して
11 * 正規表現パターンにマッチした箇所の開始位置と長さを配列で返します。
12 * マッチしない場合は false を返します。
13 *
14 * @param string $text 検索対象の文字列。
15 * @param string $pattern 検索に使う正規表現パターン。
16 * @return void
17 */
18function findAndShowMatchPosition(string $text, string $pattern): void
19{
20    echo "--- 検索開始 ---\n";
21    echo "検索対象テキスト: '{$text}'\n";
22    echo "正規表現パターン: '{$pattern}'\n";
23
24    // 検索対象の文字列を初期化します。
25    // mb_ereg_search_pos は、この初期化された文字列に対して検索を行います。
26    mb_ereg_search_init($text);
27
28    // 正規表現パターンに最初にマッチした箇所の開始位置と長さを取得します。
29    // 結果は `[開始位置, 長さ]` の形式の配列か、マッチしない場合は `false` です。
30    $matchPosition = mb_ereg_search_pos($pattern);
31
32    if ($matchPosition === false) {
33        echo "結果: マッチする箇所は見つかりませんでした。\n";
34    } else {
35        // マッチした場合、$matchPosition は2つの要素を持つ配列です。
36        // 最初の要素はマッチ開始位置（0から始まる）、2番目の要素はマッチした文字列の長さです。
37        $start = $matchPosition[0];
38        $length = $matchPosition[1];
39
40        // マッチした部分文字列を抽出します。
41        $matchedString = mb_substr($text, $start, $length);
42
43        echo "結果: マッチが見つかりました。\n";
44        echo "  開始位置: {$start}\n";
45        echo "  長さ: {$length}\n";
46        echo "  マッチした文字列: '{$matchedString}'\n";
47    }
48    echo "--- 検索終了 ---\n\n";
49}
50
51// --- サンプルコードの実行例 ---
52
53// 例1: 日本語文字列内での検索
54findAndShowMatchPosition("これはPHPの正規表現テストです。", "正規表現");
55
56// 例2: 英語文字列内での検索
57findAndShowMatchPosition("Hello World from PHP.", "World");
58
59// 例3: マッチしない場合の例
60findAndShowMatchPosition("プログラミングは楽しい。", "Ruby");
61
62// 例4: 数字の検索
63findAndShowMatchPosition("バージョンはPHP 8です。", "\d+");
64
65// 例5: 複数のマッチがある場合、最初のマッチのみを返す
66findAndShowMatchPosition("りんご、みかん、ぶどう", "ん");
67

このPHPサンプルコードは、mb_ereg_search_pos関数を用いて、文字列の中から正規表現にマッチする最初の箇所の「開始位置」と「長さ」を検索する方法を示しています。この関数は、日本語のようなマルチバイト文字を正確に扱えるPHPの拡張機能の一部です。

まず、コードの冒頭でmb_internal_encoding("UTF-8");と設定することで、マルチバイト文字（例えば日本語）が正しく処理されるように準備しています。これは、文字化けを防ぎ、正確な検索を行う上で非常に重要です。

実際の検索処理はfindAndShowMatchPosition関数内で行われます。mb_ereg_search_pos関数を使う前には、必ずmb_ereg_search_init($text);を呼び出して、どの文字列を検索対象とするかをPHPに伝える必要があります。mb_ereg_search_posは、このmb_ereg_search_initで設定された文字列に対して、引数として渡された$pattern（正規表現）を用いて検索を実行します。

検索の結果、正規表現にマッチする箇所が見つかった場合、mb_ereg_search_posは2つの要素を持つ配列を返します。配列の最初の要素はマッチ箇所の文字列の開始位置（0から数えます）、2番目の要素はマッチした文字列の長さを示します。もしマッチする箇所が見つからなかった場合は、falseが返されます。サンプルコードでは、この戻り値を利用して、マッチした文字列をmb_substrで抽出し、開始位置、長さ、そしてマッチした文字列自体を表示しています。これにより、初心者が正規表現による文字列検索の挙動を具体的に理解できるようになっています。