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

Copy
1<?php
2
3/**
4 * PHP 8 の OuterIterator::current メソッドのサンプルコード。
5 *
6 * OuterIterator インターフェースを実装する IteratorIterator を使用し、
7 * 内部イテレータの現在の要素を取得する方法を示します。
8 * このコードは、PHP の安定版 (PHP 8) で動作します。
9 */
10
11// 1. 内部イテレータとして使用するデータを準備します。
12// ここではシンプルな文字列の配列を使用します。
13$data = ['Apple', 'Banana', 'Cherry', 'Date'];
14
15// 2. 内部イテレータを作成します。
16// ArrayIterator は PHP の標準ライブラリ (SPL) の一部で、
17// 配列を反復処理するための Iterator インターフェースを実装しています。
18$innerIterator = new ArrayIterator($data);
19
20// 3. OuterIterator を実装する IteratorIterator でラップします。
21// IteratorIterator も SPL の一部で、別のイテレータ (内部イテレータ) をラップし、
22// 自身もイテレータとして振る舞うことができます。
23// OuterIterator インターフェースを実装しているため、current() メソッドを提供します。
24$outerIterator = new IteratorIterator($innerIterator);
25
26echo "--- OuterIterator::current() メソッドの動作確認 ---\n";
27
28// イテレータを最初の要素にリセットします。
29// current() を呼び出す前にイテレータが有効な位置にあることを保証するために重要です。
30$outerIterator->rewind();
31
32// OuterIterator の current() メソッドを使用して、
33// 内部イテレータの現在の要素を取得します。
34// 戻り値は mixed 型で、内部イテレータの current() が返す値そのままです。
35$firstElement = $outerIterator->current();
36echo "最初の要素 (rewind 直後): " . $firstElement . "\n"; // 出力: 最初の要素 (rewind 直後): Apple
37
38// イテレータを次の要素に進めます。
39$outerIterator->next();
40
41// 再び current() を呼び出すと、次の要素が取得できます。
42$secondElement = $outerIterator->current();
43echo "次の要素 (next() 後): " . $secondElement . "\n"; // 出力: 次の要素 (next() 後): Banana
44
45// foreach ループで OuterIterator を使用する例です。
46// foreach は内部で rewind(), valid(), current(), key(), next() を自動的に呼び出します。
47echo "\n--- foreach ループでの OuterIterator の利用 ---\n";
48// 注意: 上記で next() が呼ばれているため、'Cherry' から始まります。
49foreach ($outerIterator as $key => $value) {
50    echo "キー: $key, 値: $value\n";
51}
52
53?>

PHP 8で利用できるOuterIterator::currentメソッドは、他のイテレータ（内部イテレータ）をラップして操作するOuterIteratorインターフェースが提供する重要な機能です。このメソッドは引数を一切受け取らず、現在イテレータが指し示している内部イテレータの要素を返します。戻り値の型はmixedで、内部イテレータがどのような型のデータを保持しているかによって返される値の型は異なります。

サンプルコードでは、まずシンプルな配列を反復処理するためのArrayIteratorを内部イテレータとして用意しています。次に、このArrayIteratorをOuterIteratorインターフェースを実装するIteratorIteratorでラップしています。これにより、IteratorIteratorを通して内部のArrayIteratorの要素にアクセスできるようになります。

コードの実行例では、rewind()メソッドでイテレータを初期位置に戻した後、outerIterator->current()を呼び出すことで最初の要素「Apple」を取得しています。その後、next()メソッドでイテレータを次の位置に進め、再度current()を呼び出すことで次の要素「Banana」を取得できることを示しています。このように、OuterIterator::current()は、イテレータが現在どの要素に位置しているかを確認するために使用されます。また、foreachループでOuterIteratorを利用する場合も、内部的にはこれらのメソッドが自動的に呼び出され、要素を順次取得しています。

Copy
1<?php
2
3/**
4 * OuterIterator インターフェースを実装したカスタムイテレータ。
5 * これは、別のイテレータ（内部イテレータ）をラップし、その動作を委譲します。
6 * OuterIterator::current() メソッドの動作を理解するのに役立ちます。
7 */
8class MyOuterIterator implements OuterIterator
9{
10    private Iterator $innerIterator;
11
12    /**
13     * コンストラクタ。内部イテレータを受け取ります。
14     *
15     * @param Iterator $innerIterator ラップするイテレータ
16     */
17    public function __construct(Iterator $innerIterator)
18    {
19        $this->innerIterator = $innerIterator;
20    }
21
22    /**
23     * ラップしている内部イテレータを返します。
24     */
25    public function getInnerIterator(): Iterator
26    {
27        return $this->innerIterator;
28    }
29
30    /**
31     * 現在の要素の値を返します。
32     * このメソッドは、OuterIterator::current() の働きを示すこの例の核です。
33     * 内部イテレータの current() メソッドに処理を委譲します。
34     *
35     * @return mixed 現在の要素の値
36     */
37    public function current(): mixed
38    {
39        return $this->innerIterator->current();
40    }
41
42    /**
43     * 現在の要素のキーを返します。
44     */
45    public function key(): mixed
46    {
47        return $this->innerIterator->key();
48    }
49
50    /**
51     * イテレータを次の要素に進めます。
52     */
53    public function next(): void
54    {
55        $this->innerIterator->next();
56    }
57
58    /**
59     * イテレータを最初の要素に巻き戻します。
60     */
61    public function rewind(): void
62    {
63        $this->innerIterator->rewind();
64    }
65
66    /**
67     * 現在のイテレータの位置が有効かどうかをチェックします。
68     */
69    public function valid(): bool
70    {
71        return $this->innerIterator->valid();
72    }
73}
74
75// PHPの各バージョンとその主要な機能を示すサンプルデータ。
76// "2025" キーワードに関連付けられるように、仮想の将来バージョンを含みます。
77$phpVersionsData = [
78    'PHP 8.0'          => 'Attributes, Constructor Property Promotion, Match Expression',
79    'PHP 8.1'          => 'Enums, Fibers, Readonly Properties',
80    'PHP 8.2'          => 'Readonly Classes, Disjunctive Normal Form Types',
81    'PHP 8.3'          => 'Typed Class Constants, `json_validate()`',
82    'PHP 8.4 (2025)'   => 'Hypothetical future features for PHP in 2025', // 2025年のPHPに関する仮想データ
83];
84
85// サンプルデータから内部イテレータ (ArrayIterator) を作成します。
86$innerIterator = new ArrayIterator($phpVersionsData);
87
88// 内部イテレータを MyOuterIterator でラップします。
89$outerIterator = new MyOuterIterator($innerIterator);
90
91echo "OuterIterator::current() を使用したPHPバージョン機能のリスト:\n";
92echo "---------------------------------------------------------\n";
93
94// OuterIterator を反復処理し、各要素の current() メソッドの戻り値を出力します。
95foreach ($outerIterator as $versionKey => $features) {
96    // foreachループは暗黙的にcurrent()、key()、next()、valid()を呼び出しますが、
97    // ここでは current() の動作を明示的に示すために、外部から $outerIterator->current() を呼び出す例を示します。
98    // 実際には、$features 変数自体が $outerIterator->current() の結果です。
99    $currentFeaturesFromMethod = $outerIterator->current();
100    echo "- " . $versionKey . ": " . $currentFeaturesFromMethod . "\n";
101}
102
103echo "---------------------------------------------------------\n";
104
105?>

PHP 8のOuterIterator::current()メソッドは、イテレータが現在指している要素の「値」を取得するために使用されます。OuterIteratorインターフェースは、別のイテレータ（内部イテレータ）を「ラップ」し、そのイテレータの操作を外部から制御できるようにする役割を持ちます。このcurrent()メソッドは引数を一切取らず、現在位置の要素の値をmixed型で返します。

このサンプルコードでは、MyOuterIteratorクラスがOuterIteratorインターフェースを実装しており、PHPのバージョンと機能のデータを持つArrayIteratorを内部イテレータとしてラップしています。MyOuterIterator::current()メソッドは、ラップしているArrayIteratorのcurrent()メソッドを呼び出し、その結果をそのまま返すことで、内部イテレータの現在位置の値を外部に公開しています。

foreachループでMyOuterIteratorを反復処理する際、ループは内部的にこのcurrent()メソッドを呼び出して、各PHPバージョンの機能説明を取得します。例えば、「PHP 8.4 (2025)」のようなデータも含まれており、current()がその時点の要素の値を正確に取得していることがわかります。この機能は、イテレータを介してデータにアクセスする際の「現在の値」を提供する重要な役割を担っています。