Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】RegexIterator::INVERT_MATCH定数の使い方

INVERT_MATCH定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

『INVERT_MATCH定数は、RegexIteratorクラスの動作モードを制御するために使用されるフラグを表す定数です。RegexIteratorは、配列のような繰り返し処理が可能なデータ(イテレータ)に対して正規表現を適用し、パターンに一致する要素だけを抽出するためのクラスです。通常、RegexIteratorはコンストラクタで指定された正規表現にマッチした要素を返します。しかし、このINVERT_MATCH定数をフラグとして指定すると、その動作が反転します。つまり、正規表現にマッチしなかった要素のみを返すようになります。この機能は、特定のパターンを持つ要素を除外した結果を効率的に得たい場合に非常に有用です。例えば、ログファイルからエラーメッセージが含まれていない行だけを抽出したり、特定の形式に当てはまらないデータだけをフィルタリングしたりする際に活用できます。この定数は、RegexIteratorのインスタンスを生成する際のコンストラクタの第4引数に設定して使用します。』

構文(syntax)

1<?php
2
3$subject = new ArrayObject(['apple', 'banana', 'orange', 'apricot']);
4$iterator = $subject->getIterator();
5
6// '/^a/' にマッチしない要素のみを返すイテレータを作成します。
7$regexIterator = new RegexIterator(
8    $iterator,
9    '/^a/',
10    RegexIterator::MATCH,
11    RegexIterator::INVERT_MATCH
12);
13
14foreach ($regexIterator as $value) {
15    echo $value . PHP_EOL;
16}
17
18?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

RegexIterator::INVERT_MATCH は、正規表現にマッチしない要素を抽出するための定数です。この定数は、マッチした要素ではなく、マッチしなかった要素を RegexIterator が返すように指示します。

サンプルコード

PHP RegexIterator INVERT_MATCHでマッチしない要素を抽出する

1<?php
2
3/**
4 * RegexIterator::INVERT_MATCH 定数の動作を示すサンプル関数。
5 *
6 * この定数は、RegexIterator がパターンにマッチする要素ではなく、
7 * パターンにマッチしない要素を返すように動作を反転させるために使用されます。
8 * その値は整数型 (int) です。
9 */
10function demonstrateRegexIteratorInvertMatch(): void
11{
12    // フィルタリング対象となるデータ配列を準備
13    $data = ['apple', 'banana', 'orange', 'grape', 'apricot', 'avocado', 'kiwi'];
14
15    // 検索する正規表現パターンを定義(例: 'a' で始まる文字列)
16    $pattern = '/^a/';
17
18    echo "--- 元のデータ配列 ---\n";
19    foreach ($data as $item) {
20        echo "- " . $item . "\n";
21    }
22    echo "\n";
23
24    echo "--- 検索パターン: " . $pattern . " ('a' で始まる文字列) ---\n\n";
25
26    // ArrayIterator を使用して、配列をイテレータとしてラップ
27    $arrayIterator = new ArrayIterator($data);
28
29    // RegexIterator を作成し、上記のイテレータと正規表現パターンを渡す
30    $regexIterator = new RegexIterator($arrayIterator, $pattern);
31
32    echo "--- RegexIterator::INVERT_MATCH を使用しない場合 ---\n";
33    echo "  (パターンに合致する要素のみが出力されます)\n";
34    // デフォルトでは、パターンに合致する要素のみがイテレートされます。
35    foreach ($regexIterator as $value) {
36        echo $value . "\n";
37    }
38    echo "\n";
39
40    // RegexIterator::INVERT_MATCH フラグを設定
41    // この定数を設定することで、RegexIterator の動作が反転し、
42    // パターンに合致しない要素のみがイテレートされるようになります。
43    $regexIterator->setFlags(RegexIterator::INVERT_MATCH);
44
45    echo "--- RegexIterator::INVERT_MATCH を使用した場合 ---\n";
46    echo "  (パターンに合致しない要素のみが出力されます)\n";
47    // INVERT_MATCH が設定されているため、パターン('/^a/')に合致しない要素が返されます。
48    foreach ($regexIterator as $value) {
49        echo $value . "\n";
50    }
51    echo "\n";
52}
53
54// 関数を実行して、RegexIterator::INVERT_MATCH の動作を確認
55demonstrateRegexIteratorInvertMatch();

PHPのRegexIterator::INVERT_MATCHは、RegexIteratorクラスに定義された定数の一つです。この定数は整数型(int)の値を持ち、特定の引数はありません。

RegexIteratorは通常、指定された正規表現パターンに「合致する」要素のみをフィルタリングして提供します。しかし、このINVERT_MATCH定数をsetFlags()メソッドで設定すると、RegexIteratorの動作が反転します。その結果、パターンに「合致しない」要素のみがフィルタリングされ、イテレータから返されるようになります。

提供されたサンプルコードでは、まずフルーツ名の配列を用意し、「'a'で始まる文字列」を検索パターンとして設定しています。RegexIterator::INVERT_MATCHを設定しない場合は、このパターンに合致する「apple」などが表示されます。その後、$regexIterator->setFlags(RegexIterator::INVERT_MATCH);によってこの定数を設定し直すと、動作が反転し、パターンに合致しない「banana」や「kiwi」といった要素のみが出力されることが確認できます。このように、フィルタリングの条件を簡単に逆転させたい場合に活用できる便利な定数です。

RegexIterator::INVERT_MATCHは、正規表現に「合致しない」要素を抽出したい時に設定する定数です。この定数を設定しない場合のデフォルト動作は「合致する」要素を抽出しますので、その違いを理解することが重要です。設定するにはRegexIteratorオブジェクトのsetFlags()メソッドにRegexIterator::INVERT_MATCHを渡します。この定数自体は整数値を表すもので、直接実行するものではありません。一度setFlags()で設定すると、そのRegexIteratorオブジェクトは以降、パターンに合致しない要素を返す動作に変わりますので、適切なタイミングで設定してください。

PHP8 match, instanceofで逆マッチングする

1<?php
2
3/**
4 * RegexIterator::INVERT_MATCH の使用例と PHP 8 の 'match' 式、'instanceof' キーワードのデモンストレーション。
5 *
6 * この関数は、指定された文字列配列から特定のパターンに「一致しない」要素を抽出し、
7 * その結果を PHP 8 の 'match' 式を用いて処理します。
8 * 'instanceof' キーワードは、イテレータオブジェクトの型チェックに使用します。
9 */
10function demonstrateInvertMatchWithPhp8Features(): void
11{
12    // 処理対象となる文字列の配列
13    $data = [
14        'apple pie',
15        'banana bread',
16        'cherry tart',
17        'date cake',
18        'elderberry jam',
19        'red apple',
20        'green grape',
21    ];
22
23    // ArrayIterator で配列をラップし、イテレータとして扱えるようにする
24    $arrayIterator = new ArrayIterator($data);
25
26    // RegexIterator を使用して、正規表現に「一致しない」要素をフィルタリングする
27    // RegexIterator::INVERT_MATCH フラグにより、正規表現 '/apple/' に一致しない要素が選ばれます。
28    $invertedRegexIterator = new RegexIterator(
29        $arrayIterator,
30        '/apple/', // 正規表現パターン: 「apple」を含む文字列
31        RegexIterator::INVERT_MATCH // このフラグで逆マッチ (「apple」を含まない文字列)
32    );
33
34    // --- instanceof キーワードのデモンストレーション ---
35    // イテレータオブジェクトが Iterator インターフェースを実装しているかを確認
36    if ($arrayIterator instanceof Iterator) {
37        echo "ArrayIterator は Iterator インターフェースを実装しています。\n";
38    }
39    if ($invertedRegexIterator instanceof Iterator) {
40        echo "RegexIterator は Iterator インターフェースを実装しています。\n";
41    }
42    echo "--------------------------------------------------------\n\n";
43
44    echo "--- RegexIterator::INVERT_MATCH のデモンストレーション ---\n";
45    echo "オリジナルデータ:\n";
46    foreach ($data as $item) {
47        echo "- " . $item . "\n";
48    }
49    echo "\nパターン '/apple/' に一致しない (逆マッチング) 要素:\n";
50
51    // フィルタリングされた要素をループで処理
52    foreach ($invertedRegexIterator as $key => $value) {
53        // PHP 8 の 'match' 式のデモンストレーション
54        // フィルタリングされた文字列の特性に応じて異なるメッセージを生成します。
55        // 'match' 式は、厳密な比較 (===) を行い、対応するブロックの値を返します。
56        $status = match (true) {
57            // str_contains は PHP 8 で導入された文字列関数
58            str_contains($value, 'bread') => "「bread」を含んでいます。",
59            strlen($value) > 12 => "比較的長い文字列です。",
60            default => "その他の文字列です。",
61        };
62
63        echo sprintf(
64            "キー: %d, 値: '%s', 処理ステータス: %s\n",
65            $key,
66            $value,
67            $status
68        );
69    }
70    echo "--------------------------------------------------------\n";
71}
72
73// 関数を実行し、結果を出力
74demonstrateInvertMatchWithPhp8Features();

このPHPサンプルコードは、PHP 8で導入された新しい構文と、既存のイテレータ機能を組み合わせて、データのフィルタリングと条件に応じた処理を行う方法を示しています。

まず、RegexIterator::INVERT_MATCH定数について説明します。これはRegexIteratorクラスに属する整数値のフラグで、引数はなく、正規表現に「一致しない」要素を抽出するために使用されます。この定数を用いることで、指定したパターン(例えば「apple」)を含まない文字列だけを効率的に選り分けることができます。

次に、instanceofキーワードは、変数が特定のクラスのインスタンスであるか、または特定のインターフェースを実装しているかを確認するために使用されます。これにより、コードの安全性と信頼性が向上し、オブジェクトの型に応じた適切な処理を確実に実行できます。

最後に、PHP 8の新機能であるmatch式についてです。これは、複数の条件の中から最初に合致する式に基づいて値を返す新しい制御構造です。従来のswitch文よりも簡潔に記述でき、厳密な比較(===)を行う点が特徴です。このサンプルでは、フィルタリングされた文字列の内容に応じて、PHP 8で追加されたstr_contains関数などを用いて異なるメッセージを生成しています。これらの機能を活用することで、効率的で読みやすいコードが書けるようになります。

RegexIterator::INVERT_MATCHは、正規表現に「一致する」要素ではなく、「一致しない」要素を抽出するためのフラグです。このフラグの有無でフィルタリング結果が逆になるため、意図した通りの挙動かを確認してください。PHP 8で導入されたmatch式は、switch文に似ていますが、より厳密な比較(===)を行い、必ず値を返します。すべての条件に合致しない場合にUnhandledMatchErrorが発生しないよう、default句を記述して安全性を高めることをおすすめします。instanceofキーワードは、オブジェクトが特定のクラスのインスタンスであるか、またはインターフェースを実装しているかを安全に確認するために利用します。これにより、オブジェクトの型に応じた適切な処理を記述できます。このサンプルコードはPHP 8の機能を使用しているため、PHP 8以降の環境で実行する必要があります。

関連コンテンツ

関連IT用語

関連プログラミング言語