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

Copy
1<?php
2
3/**
4 * RegexIterator::getInnerIterator() の使用例を示します。
5 *
6 * このメソッドは、RegexIterator がラップしている内部イテレータ（元のデータソース）を取得します。
7 * RegexIterator は、内部イテレータから取得した要素を正規表現でフィルタリングして提供しますが、
8 * getInnerIterator() を使うと、フィルタリング前の元のデータにアクセスできます。
9 */
10
11// 1. 内部イテレータとして使用するデータを準備します。
12$data = [
13    'apple',
14    'banana',
15    '123pear',  // 数字を含む
16    'orange456',// 数字を含む
17    'grape',
18    'kiwi7',    // 数字を含む
19];
20
21// 2. ArrayIterator を使って、上記データを内部イテレータとして作成します。
22$originalInnerIterator = new ArrayIterator($data);
23
24echo "--- 元の内部イテレータの内容 (フィルタリングなし) ---\n";
25foreach ($originalInnerIterator as $item) {
26    echo $item . "\n";
27}
28echo "\n";
29
30// 3. RegexIterator を作成し、元の内部イテレータをラップします。
31//    ここでは、文字列内に数字を含む要素のみをフィルタリングする正規表現を設定します。
32$regexIterator = new RegexIterator(
33    $originalInnerIterator,
34    '/\\d/', // 正規表現: いずれかの数字 (\d) にマッチ
35    RegexIterator::MATCH // マッチした要素を返すモード
36);
37
38echo "--- RegexIterator によるフィルタリング結果 (数字を含む要素のみ) ---\n";
39foreach ($regexIterator as $item) {
40    echo $item . "\n";
41}
42echo "\n";
43
44// 4. RegexIterator::getInnerIterator() を使用して、ラップされている内部イテレータを取得します。
45//    これにより、フィルタリングされる前の元のデータソースにアクセスできます。
46$retrievedInnerIterator = $regexIterator->getInnerIterator();
47
48echo "--- getInnerIterator() で取得した内部イテレータの内容 ---\n";
49// イテレータは一度ループするとポインタが終端に移動している可能性があるため、
50// 再度最初からループするために rewind() を呼び出します。
51if ($retrievedInnerIterator instanceof Iterator) {
52    $retrievedInnerIterator->rewind();
53    foreach ($retrievedInnerIterator as $item) {
54        echo $item . "\n";
55    }
56} else {
57    echo "取得されたオブジェクトはイテレータではありません。\n";
58}
59echo "\n";
60
61// 注釈:
62// getInnerIterator() は、RegexIterator がコンストラクタで受け取った
63// 実際の Iterator オブジェクトを返します。
64// したがって、この例では $retrievedInnerIterator は $originalInnerIterator と
65// 同じインスタンス（データ）を指します。

RegexIterator::getInnerIterator()メソッドは、PHPのRegexIteratorクラスが内部でラップしている「元のイテレータ」（データソース）を取得するためのメソッドです。RegexIteratorは、内部のイテレータから取得した要素を正規表現によってフィルタリングし、条件に合うものだけを外部に提供する役割を持っています。

このメソッドを利用すると、RegexIteratorによってフィルタリングされる前の、元の全てのデータ要素にアクセスできるイテレータを再び取得できます。例えば、サンプルコードでは数字を含む要素をフィルタリングするRegexIteratorを作成していますが、getInnerIterator()を使うことで、フィルタリング前の全てのフルーツ名が含まれるイテレータを取り戻し、元の状態のデータを確認できます。

このメソッドは引数を取らずに呼び出します。戻り値は、RegexIteratorのコンストラクタに渡された元のIteratorオブジェクト、または内部イテレータが存在しない場合はnullを返します。これにより、RegexIteratorによる特定のフィルタリング処理を行った後でも、元のデータソースに簡単に戻ってアクセスすることが可能になり、多様なデータ操作を柔軟に行えます。

Copy
1<?php
2
3/**
4 * RegexIterator::getInnerIterator() メソッドの動作を示すサンプルコード。
5 *
6 * この関数は、PHPのイテレータとジェネレータの概念を使用し、
7 * RegexIterator がラップしている元のイテレータを取得する方法を実演します。
8 */
9function demonstrateRegexIteratorGetInnerIterator(): void
10{
11    // 1. ジェネレータを使って内部イテレータを作成
12    // ジェネレータはIteratorインターフェースを実装しており、イテレータとして機能します。
13    // 一度生成されたジェネレータは、一度しか完全にイテレートできません。
14    $originalInnerIterator = (function (): Generator {
15        yield 'apple';
16        yield 'banana';
17        yield 'apricot';
18        yield 'grape';
19        yield 'orange';
20    })(); // 即時実行してGeneratorオブジェクトを取得
21
22    echo "--- 1. 元の内部イテレータの初期状態 ---\n";
23    echo "元の内部イテレータはまだ消費されていません。\n";
24
25    // 2. RegexIteratorを作成し、内部イテレータをラップ
26    // ここでは、'a'で始まる単語をフィルタリングする正規表現を指定します。
27    $regexIterator = new RegexIterator($originalInnerIterator, '/^a/', RegexIterator::MATCH);
28
29    // 3. RegexIteratorから getInnerIterator() を使って内部イテレータを取得
30    // このメソッドは、RegexIteratorがラップしている元のIteratorオブジェクトそのものを返します。
31    $retrievedInnerIterator = $regexIterator->getInnerIterator();
32
33    echo "\n--- 2. getInnerIterator() で取得したイテレータの確認 ---\n";
34    // 取得したイテレータが元のイテレータと同一のオブジェクトであることを確認します。
35    // PHPでは `===` 演算子でオブジェクトの同一性（同じインスタンスを指しているか）を比較できます。
36    if ($originalInnerIterator === $retrievedInnerIterator) {
37        echo "getInnerIterator() で取得したイテレータは、元の内部イテレータと同一のオブジェクトです。\n";
38    } else {
39        echo "getInnerIterator() で取得したイテレータは、元の内部イテレータと異なるオブジェクトです。\n";
40    }
41
42    echo "\n--- 3. RegexIterator を通してフィルタリングされた値を表示 ---\n";
43    echo "RegexIterator は内部イテレータを消費しながら、正規表現に一致する項目だけをフィルタリングして表示します。\n";
44    foreach ($regexIterator as $key => $value) {
45        echo "  - キー: {$key}, 値: {$value}\n";
46    }
47
48    echo "\n--- 4. イテレート後の内部イテレータの状態 ---\n";
49    echo "RegexIterator を通してイテレートしたことで、元の内部イテレータ（と getInnerIterator() で取得したもの）は既に消費されています。\n";
50    echo "再度元のイテレータをイテレートしようと試みますが、何も表示されないはずです (ジェネレータは一度しかイテレートできません)。\n";
51    foreach ($originalInnerIterator as $value) {
52        echo "  - 値 (再イテレート): {$value}\n"; // ここは表示されません
53    }
54}
55
56// 上記の関数を呼び出して実行します。
57demonstrateRegexIteratorGetInnerIterator();
58
59?>

PHPのRegexIterator::getInnerIterator()メソッドは、データ群を正規表現でフィルタリングするRegexIteratorが、その処理対象としている元のイテレータを取得する際に使用します。このメソッドは引数を必要とせず、内部でラップされているIteratorオブジェクト、または存在しない場合はnullを返します。

返されるイテレータは、RegexIteratorが実際にデータを読み取る元のインスタンスと同一であり、コピーではありません。そのため、RegexIteratorを通して要素を繰り返し処理すると、getInnerIterator()で取得したイテレータも同時に消費されます。特にジェネレータのように一度しかイテレートできないイテレータの場合、この点は重要です。

サンプルコードでは、イテレータの一種であるジェネレータを用いて元のデータ列を作成し、それをRegexIteratorでラップしています。そして、getInnerIterator()で元のイテレータを正確に取得し、それが元のジェネレータと同一のオブジェクトであることを確認しています。さらに、RegexIteratorの処理によって元のイテレータが消費される様子も示しており、RegexIteratorが内部イテレータをどのように利用しているかが具体的に理解できます。