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

Copy
1<?php
2
3/**
4 * SeekableIterator::current() メソッドの使用例。
5 *
6 * このコードは、PHP 8 で安定版のイテレータ（ArrayIterator）が
7 * current() メソッドを使用して現在位置の要素にアクセスする方法を示します。
8 * ArrayIterator クラスは SeekableIterator インターフェースを実装しています。
9 *
10 * システムエンジニアを目指す初心者の方向けに、イテレータの基本的な動きと
11 * current() メソッドの役割を段階的に説明します。
12 */
13
14// 1. ArrayIterator のインスタンスを作成します。
15//    これは、指定された配列の要素を順に処理するためのイテレータです。
16$data = ['Apple', 'Banana', 'Cherry', 'Date'];
17$iterator = new ArrayIterator($data);
18
19// 2. イテレータを最初の要素に巻き戻します。
20//    通常、ArrayIterator はインスタンス作成時に最初の要素を指しますが、
21//    rewind() を明示的に呼ぶことで、常に初期状態から開始することを保証できます。
22$iterator->rewind();
23echo "--- 初期状態 ---" . PHP_EOL;
24
25// 3. current() メソッドを呼び出し、現在位置の要素を取得して表示します。
26//    初期状態では、配列の最初の要素である 'Apple' が返されます。
27echo "現在の要素: " . $iterator->current() . PHP_EOL; // 出力例: Apple
28echo "現在のキー: " . $iterator->key() . PHP_EOL;     // 出力例: 0
29
30// 4. next() メソッドを呼び出し、イテレータを次の要素に進めます。
31$iterator->next();
32echo PHP_EOL . "--- 次の要素へ進んだ後 ---" . PHP_EOL;
33
34// 5. 再度 current() メソッドを呼び出し、新しい現在位置の要素を取得して表示します。
35//    next() の呼び出しにより、現在位置は 'Banana' に移動しています。
36echo "現在の要素: " . $iterator->current() . PHP_EOL; // 出力例: Banana
37echo "現在のキー: " . $iterator->key() . PHP_EOL;     // 出力例: 1
38
39// 6. さらにイテレータを進めて、終端に達した場合の current() の動作を確認します。
40$iterator->next(); // 'Cherry' へ
41$iterator->next(); // 'Date' へ
42$iterator->next(); // 配列の終端を超過
43echo PHP_EOL . "--- 終端を超過した後 ---" . PHP_EOL;
44
45// イテレータが有効な要素を指していない場合（配列の終端を超えた場合など）、
46// current() は null を返します。
47echo "現在の要素 (終端後): " . var_export($iterator->current(), true) . PHP_EOL; // 出力例: NULL
48// valid() メソッドでイテレータが有効な位置にあるか確認できます。
49echo "イテレータは有効な位置か: " . var_export($iterator->valid(), true) . PHP_EOL; // 出力例: false
50
51?>

PHP 8 で安定版のSeekableIterator::current()メソッドは、イテレータが現在指し示している要素の値を取得するために利用されます。このメソッドは引数を受け取らず、現在の要素の値をmixed型で返します。mixed型とは、文字列、数値、オブジェクトなど、PHPのあらゆる型のデータが戻り値になり得ることを意味します。

サンプルコードでは、配列の要素を順に処理するArrayIteratorを例に、current()メソッドの動作を解説しています。まず、rewind()メソッドでイテレータを初期位置に戻すと、コレクションの最初の要素を指すようになります。この状態でcurrent()を呼び出すと、最初の要素の値が取得され、例えば'Apple'が返されます。

その後、next()メソッドを呼び出すとイテレータの内部ポインタが次の要素へ進み、再度current()を呼び出すことで、新しい現在位置の要素、例えば'Banana'が取得されます。このように、current()はイテレータの現在位置の要素を「参照」する役割を担います。

イテレータがコレクションの終端を超えて有効な要素を指していない状態になると、current()はnullを返します。これは、もう処理すべき要素がないことを示しており、通常はvalid()メソッドと組み合わせてイテレータの有効性を確認しながらループ処理を行います。current()メソッドは、イテレータを使用してコレクション内の各要素にアクセスする際の基盤となる、非常に重要なメソッドです。

Copy
1<?php
2
3/**
4 * SeekableIterator インターフェースを実装したカスタムイテレータの例。
5 * 配列の要素を順次取得したり、特定のインデックスに直接シーク（移動）したりできます。
6 *
7 * システムエンジニアを目指す初心者の方へ:
8 * イテレータは、配列のようなコレクションの要素を一つずつ順番に処理するためのパターンです。
9 * SeekableIterator は、さらに特定の場所にジャンプする機能（seek）を追加します。
10 * current() メソッドは、イテレータが現在指している要素を返します。
11 * PHP 8 環境でこのコードは動作します。
12 */
13class MySeekableArrayIterator implements SeekableIterator
14{
15    /**
16     * イテレートするデータを保持する配列。
17     */
18    private array $data;
19
20    /**
21     * イテレータの現在の位置（インデックス）。
22     */
23    private int $position = 0;
24
25    /**
26     * コンストラクタ。イテレートする配列を受け取ります。
27     *
28     * @param array $inputArray イテレートする配列
29     */
30    public function __construct(array $inputArray)
31    {
32        // 外部から渡された配列を内部で保持します。
33        // array_values() でキーを0から振り直すことで、イテレータの内部処理をシンプルに保ちます。
34        $this->data = array_values($inputArray);
35    }
36
37    /**
38     * 現在のイテレータの位置にある要素を返します。
39     * これが SeekableIterator::current() メソッドの具体的な実装です。
40     *
41     * @return mixed 現在の要素
42     */
43    public function current(): mixed
44    {
45        // 現在の $position が指す配列の要素を返します。
46        return $this->data[$this->position];
47    }
48
49    /**
50     * 現在のイテレータの位置（キー）を返します。
51     * この例では、配列のインデックスがキーとなります。
52     *
53     * @return int 現在のキー（インデックス）
54     */
55    public function key(): int
56    {
57        return $this->position;
58    }
59
60    /**
61     * イテレータを次の要素に進めます。
62     * 内部の $position をインクリメントします。
63     */
64    public function next(): void
65    {
66        ++$this->position;
67    }
68
69    /**
70     * イテレータを最初の要素に巻き戻します。
71     * 内部の $position を 0 にリセットします。
72     */
73    public function rewind(): void
74    {
75        $this->position = 0;
76    }
77
78    /**
79     * 現在のイテレータの位置が有効な要素を指しているかを確認します。
80     *
81     * @return bool 有効な場合は true、それ以外は false
82     */
83    public function valid(): bool
84    {
85        // 現在の $position が配列の範囲内にあるかを確認します。
86        return isset($this->data[$this->position]);
87    }
88
89    /**
90     * イテレータを特定のインデックス（位置）に直接移動させます。
91     * これが SeekableIterator インターフェース独自のメソッドです。
92     *
93     * @param int $position シークするインデックス
94     * @throws OutOfBoundsException 指定されたインデックスが存在しない場合
95     */
96    public function seek(int $position): void
97    {
98        // シークしようとしている位置が配列の範囲外であれば例外を投げます。
99        if (!isset($this->data[$position])) {
100            throw new OutOfBoundsException("指定されたインデックス ({$position}) は存在しません。");
101        }
102        // 位置が有効であれば、内部の $position をその値に設定します。
103        $this->position = $position;
104    }
105}
106
107// --- MySeekableArrayIterator の使用例 ---
108
109// サンプルデータを用意します。
110$fruits = ['Apple', 'Banana', 'Cherry', 'Date', 'Elderberry'];
111
112// MySeekableArrayIterator のインスタンスを作成します。
113$fruitIterator = new MySeekableArrayIterator($fruits);
114
115echo "--- 1. foreach ループでの利用 (current() は内部で呼ばれる) ---\n";
116// foreach ループはイテレータインターフェースを実装したオブジェクトに対して使えます。
117// 内部的には rewind() -> valid() -> current(), key() -> next() の順にメソッドが呼ばれます。
118foreach ($fruitIterator as $index => $fruit) {
119    echo "インデックス: {$index}, フルーツ: {$fruit}\n";
120}
121
122echo "\n--- 2. seek() と current() を直接使った例 ---\n";
123
124// イテレータを最初の位置に巻き戻します (foreach で最後の要素まで進んでいるため)。
125$fruitIterator->rewind();
126echo "イテレータを巻き戻しました。現在の要素: " . $fruitIterator->current() . " (インデックス: " . $fruitIterator->key() . ")\n"; // Apple
127
128// イテレータをインデックス 2 (3番目の要素) にシークします。
129$fruitIterator->seek(2);
130echo "インデックス 2 にシークしました。現在の要素: " . $fruitIterator->current() . " (インデックス: " . $fruitIterator->key() . ")\n"; // Cherry
131
132// さらにイテレータをインデックス 4 (5番目の要素) にシークします。
133$fruitIterator->seek(4);
134echo "インデックス 4 にシークしました。現在の要素: " . $fruitIterator->current() . " (インデックス: " . $fruitIterator->key() . ")\n"; // Elderberry
135
136// その後、次の要素に進みます。
137$fruitIterator->next();
138// valid() で要素が存在するか確認してから current() を呼ぶのが安全です。
139if ($fruitIterator->valid()) {
140    echo "次の要素に進みました。現在の要素: " . $fruitIterator->current() . " (インデックス: " . $fruitIterator->key() . ")\n";
141} else {
142    echo "次の要素に進みましたが、有効な要素はもうありません。\n";
143}
144
145echo "\n--- 3. 存在しないインデックスへのシークを試みる (エラーハンドリング) ---\n";
146try {
147    // 存在しないインデックス 10 にシークしようとします。
148    $fruitIterator->seek(10);
149    echo "これは表示されません。\n";
150} catch (OutOfBoundsException $e) {
151    echo "エラーが発生しました: " . $e->getMessage() . "\n";
152}

PHP 8で提供されるSeekableIteratorインターフェースのcurrentメソッドは、イテレータが現在指し示しているコレクションの要素を返します。このメソッドは引数を取らずに呼び出され、戻り値はmixed型であり、イテレータが扱うデータの種類に応じて任意の型になり得ます。

SeekableIteratorは、配列のような複数の要素を持つコレクションを順に処理する機能（Iteratorインターフェースの機能）に加えて、特定のインデックス（位置）へ直接移動できる機能（seekメソッド）を持つ点が特徴です。current()メソッドは、この「現在の位置」にある具体的なデータを取り出すための重要な役割を担います。

サンプルコードのMySeekableArrayIteratorクラスはSeekableIteratorを実装しており、内部で保持する配列の要素をイテレートします。このクラスのcurrent()メソッドは、イテレータの現在の内部インデックスが指す配列の要素を返しています。foreachループでイテレータを使用する場合、内部で自動的にcurrent()が呼び出され、各要素が取得されます。また、seek(int $position)メソッドでイテレータのポインタを特定のインデックスに移動させた後、current()を呼び出すことで、その移動先の要素を直接取得できるため、柔軟なデータアクセスが実現されます。