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

keyメソッドは、SeekableIteratorインターフェースを実装するクラスにおいて、イテレータが現在指し示している要素のキー（識別子）を取得するために使用されるメソッドです。SeekableIteratorインターフェースは、PHPの標準イテレータインターフェースであるIteratorを拡張したもので、コレクション内の要素を順番に巡回するだけでなく、特定の要素へ直接移動（シーク）する機能も提供します。

このkeyメソッドは、現在アクティブな要素を一意に識別するための値を返します。通常、この戻り値は整数型（例えば、数値添字配列のように0, 1, 2...と続く場合）または文字列型（連想配列のように名前で識別される場合）となります。これはPHPの配列で要素を識別する際に使用されるキーと同じ概念です。

開発者がイテレータを使ってデータを処理する際、現在どの要素に注目しているのか、その要素が持つキーは何であるかを知ることは非常に重要です。例えば、foreachループでforeach ($iterator as $key => $value)と記述した場合、このkeyメソッドが内部的に呼び出されて現在のキーが取得され、$key変数に代入されます。また、current()メソッドと合わせて使用することで、現在位置のキーと値の両方を取得し、複雑なデータ構造を効率的に探索・操作することができます。

SeekableIteratorを実装するクラスでは、rewind()やseek()といったメソッドによってイテレータの内部ポインタを自由に移動させることが可能です。どの位置に移動しても、その時点での要素のキーをkey()メソッドで正確に取得できるため、データの整合性を保ちながら柔軟な処理を実現するために不可欠な機能です。

Copy
1<?php
2$data = ['first_key' => 'value_a'];
3$iterator = new ArrayIterator($data);
4
5// SeekableIterator::key() メソッドの呼び出し構文
6$currentKey = $iterator->key();
7?>

引数なし

引数はありません

mixed

現在のイテレータ位置にある要素のキーを返します。