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

Copy
1<?php
2
3/**
4 * MyOuterIterator クラスは OuterIterator インターフェースを実装し、
5 * 別のイテレータ（内部イテレータ）をラップします。
6 * 主に getInnerIterator() メソッドの動作を示すための例です。
7 */
8class MyOuterIterator implements OuterIterator
9{
10    /**
11     * @var Iterator $innerIterator ラップしている内部イテレータ
12     */
13    private Iterator $innerIterator;
14
15    /**
16     * コンストラクタで、ラップするイテレータを受け取ります。
17     *
18     * @param Iterator $iterator ラップするイテレータ
19     */
20    public function __construct(Iterator $iterator)
21    {
22        $this->innerIterator = $iterator;
23    }
24
25    /**
26     * ラップしている内部イテレータを返します。
27     * これは OuterIterator インターフェースによって定義されたメソッドです。
28     *
29     * @return Iterator|null 内部イテレータ、または存在しない場合は null
30     */
31    public function getInnerIterator(): ?Iterator
32    {
33        return $this->innerIterator;
34    }
35
36    /**
37     * 現在の要素を返します。
38     * 内部イテレータの current() メソッドに処理を委譲します。
39     *
40     * @return mixed 現在の要素の値
41     */
42    public function current(): mixed
43    {
44        return $this->innerIterator->current();
45    }
46
47    /**
48     * 現在のキーを返します。
49     * 内部イテレータの key() メソッドに処理を委譲します。
50     *
51     * @return mixed 現在の要素のキー
52     */
53    public function key(): mixed
54    {
55        return $this->innerIterator->key();
56    }
57
58    /**
59     * ポインタを次の要素に進めます。
60     * 内部イテレータの next() メソッドに処理を委譲します。
61     */
62    public function next(): void
63    {
64        $this->innerIterator->next();
65    }
66
67    /**
68     * イテレータを先頭に巻き戻します。
69     * 内部イテレータの rewind() メソッドに処理を委譲します。
70     */
71    public function rewind(): void
72    {
73        $this->innerIterator->rewind();
74    }
75
76    /**
77     * 現在のポインタ位置が有効であるかをチェックします。
78     * 内部イテレータの valid() メソッドに処理を委譲します。
79     *
80     * @return bool 現在のポインタ位置が有効であれば true、そうでなければ false
81     */
82    public function valid(): bool
83    {
84        return $this->innerIterator->valid();
85    }
86}
87
88// -----------------------------------------------------------
89// サンプルコードの実行部分
90// -----------------------------------------------------------
91
92// 1. 内部イテレータとして使用する ArrayIterator を準備します。
93$data = ['Apple', 'Banana', 'Cherry'];
94$originalArrayIterator = new ArrayIterator($data);
95
96echo "--- 元の ArrayIterator の内容 ---" . PHP_EOL;
97foreach ($originalArrayIterator as $key => $value) {
98    echo "キー: " . $key . ", 値: " . $value . PHP_EOL;
99}
100echo PHP_EOL;
101
102// 2. MyOuterIterator をインスタンス化し、ArrayIterator をラップします。
103// OuterIterator は内部のイテレータをデコレート（装飾）します。
104$myOuterIterator = new MyOuterIterator($originalArrayIterator);
105
106// OuterIterator を介してもデータにアクセスできます。
107echo "--- MyOuterIterator を介してアクセス ---" . PHP_EOL;
108$myOuterIterator->rewind(); // ポインタを先頭にリセット
109foreach ($myOuterIterator as $key => $value) {
110    echo "キー: " . $key . ", 値: " . $value . PHP_EOL;
111}
112echo PHP_EOL;
113
114// 3. getInnerIterator() メソッドを使用して、MyOuterIterator がラップしている
115//    内部イテレータ（ArrayIterator）を直接取得します。
116echo "--- getInnerIterator() で取得した内部イテレータにアクセス ---" . PHP_EOL;
117$retrievedInnerIterator = $myOuterIterator->getInnerIterator();
118
119// 取得したイテレータが期待通りの型であるか確認します。
120if ($retrievedInnerIterator instanceof ArrayIterator) {
121    echo "内部イテレータは ArrayIterator のインスタンスです。" . PHP_EOL;
122
123    // 取得した内部イテレータを直接操作することも可能です。
124    $retrievedInnerIterator->rewind(); // ポインタを先頭にリセット
125    foreach ($retrievedInnerIterator as $key => $value) {
126        echo "キー: " . $key . ", 値: " . $value . PHP_EOL;
127    }
128} else {
129    echo "内部イテレータの取得に失敗したか、期待される型ではありません。" . PHP_EOL;
130}
131
132?>

PHPのOuterIteratorインターフェースが提供するgetInnerIterator()メソッドは、別のイテレータを「包み込む（ラップする）」形式で動作するOuterIteratorから、内部に格納されている元のイテレータを取り出す際に利用します。このメソッドは引数を一切必要としません。戻り値としては、ラップしているイテレータがIterator型のオブジェクトとして返されますが、もし何もラップしていない場合はnullが返される可能性があります。

サンプルコードでは、配列を扱うArrayIteratorで作成したイテレータを、MyOuterIteratorというカスタムのOuterIteratorクラスでラップしています。その後、myOuterIterator->getInnerIterator()を呼び出すことで、MyOuterIteratorが保持している元のArrayIteratorを直接取得し、その内容にアクセスしています。この機能は、OuterIteratorを介さずに、ラップされた元のイテレータのデータや状態を直接操作したい場合や、デバッグ時などに特に役立ちます。

Copy
1<?php
2
3// 1. ジェネレータ関数: 大量のデータをメモリ効率良く処理するためのイテレータを生成します。
4//    システムエンジニアを目指す方にとって、大規模データ処理の基礎として重要です。
5function generateNumbers(int $start, int $end): Generator
6{
7    for ($i = $start; $i <= $end; $i++) {
8        yield $i;
9    }
10}
11
12// 2. PHP組み込みの FilterIterator クラスを拡張します。
13//    FilterIterator は OuterIterator インターフェースを実装しており、
14//    別のイテレータ（内部イテレータ）をラップし、要素をフィルタリングする機能を提供します。
15class EvenNumberFilterIterator extends FilterIterator
16{
17    /**
18     * 現在の要素がフィルタリングを通過すべきかどうかを決定します。
19     *
20     * @return bool
21     */
22    public function accept(): bool
23    {
24        // 現在の要素が偶数である場合のみフィルタリングを通過させます。
25        return $this->current() % 2 === 0;
26    }
27}
28
29// データの生成元となるジェネレータを作成します。
30$generator = generateNumbers(1, 10);
31
32// ジェネレータはTraversableですが、FilterIteratorのコンストラクタはIteratorを期待します。
33// そのため、IteratorIterator を使ってジェネレータを Iterator に変換し、ラップします。
34// この $innerIterator が、OuterIterator がラップする「内部イテレータ」になります。
35$innerIterator = new IteratorIterator($generator);
36
37// EvenNumberFilterIterator のインスタンスを作成します。
38// これが OuterIterator の一種であり、内部イテレータ ($innerIterator) をラップします。
39$outerIterator = new EvenNumberFilterIterator($innerIterator);
40
41// まずは OuterIterator を使用して、フィルタリングされた偶数を出力し、動作を確認します。
42echo "--- OuterIterator による偶数のフィルタリング ---\n";
43foreach ($outerIterator as $number) {
44    echo $number . "\n";
45}
46echo "-----------------------------------------\n\n";
47
48// OuterIterator::getInnerIterator() メソッドを呼び出して、
49// この OuterIterator がラップしている内部イテレータを取得します。
50// このメソッドの戻り値は `?Iterator` (Iterator または null) です。
51$retrievedInnerIterator = $outerIterator->getInnerIterator();
52
53echo "getInnerIterator() で取得した内部イテレータの情報:\n";
54// 取得したオブジェクトのクラス名を表示し、何が返されたかを確認します。
55echo "  クラス名: " . get_class($retrievedInnerIterator) . "\n";
56
57// 取得したイテレータが、最初に OuterIterator に渡した $innerIterator と
58// 全く同じインスタンスであるかを確認します。
59if ($retrievedInnerIterator === $innerIterator) {
60    echo "  これは、OuterIterator に最初に設定した内部イテレータと同一のインスタンスです。\n";
61} else {
62    echo "  これは、OuterIterator に最初に設定した内部イテレータとは異なるインスタンスです。\n";
63}
64
65// 注意点: ジェネレータは一度しかイテレートできません。
66// したがって、もし OuterIterator が既に内部イテレータを最後まで消費している場合、
67// getInnerIterator() で取得したイテレータを再度ループしようとしても、
68// 通常は何も出力されないか、期待通りの動作をしない可能性があります。
69// getInnerIterator() の主な目的は、「現在ラップされているイテレータのインスタンス」を
70// 取得することであり、その状態を含めてアクセスすることを可能にします。

このサンプルコードは、PHPのイテレータとジェネレータ、特にOuterIteratorインターフェースとそのgetInnerIterator()メソッドの機能と役割を、システムエンジニアを目指す初心者の方にわかりやすく解説します。

まず、generateNumbers関数は、大量のデータをメモリ効率良く扱うためのジェネレータを生成します。これは大規模データ処理の基礎として重要です。次に、PHP組み込みのFilterIteratorを継承したEvenNumberFilterIteratorクラスを作成します。FilterIteratorはOuterIteratorインターフェースを実装しており、別のイテレータ（内部イテレータ）をラップして要素をフィルタリングする機能を提供します。サンプルでは、IteratorIteratorを使ってジェネレータを内部イテレータに変換し、それをEvenNumberFilterIteratorでさらにラップしています。

OuterIterator::getInnerIterator()メソッドは、このOuterIteratorがラップしている内部イテレータのインスタンスを取得するために使用されます。このメソッドは引数を受け取らず、戻り値は?Iterator型、つまりIteratorオブジェクトかnullのいずれかを返します。サンプルコードでは、フィルタリング処理が完了した後でgetInnerIterator()を呼び出し、取得したイテレータが、最初にEvenNumberFilterIteratorに渡した内部イテレータと同一のインスタンスであることを確認しています。この機能は、ラップされたイテレータの現在の状態にアクセスしたり、そのイテレータに対して追加の操作を行いたい場合に役立ちます。ただし、ジェネレータは一度しかイテレートできないため、その点には注意が必要です。