【PHP8.x】keyメソッドの使い方

keyメソッドは、AppendIteratorオブジェクトが現在指している要素のキーを取得する処理を実行するメソッドです。AppendIteratorは、複数の異なるイテレータを一つに連結し、連続した一つのデータ列として扱えるようにするクラスです。プログラミングにおけるキーとは、配列のインデックス番号や連想配列で値に対応付けられた名前など、各要素を識別するための情報を指します。foreachループなどでこの連結されたイテレータを処理する際、keyメソッドを呼び出すと、現在処理対象となっている内部イテレータが指す要素のキーが返されます。例えば、2つの配列を連結した場合、まず最初の配列を処理している間は、その配列のキーが返されます。そして、最初の配列の全要素の処理が終わると、自動的に2番目の配列の処理に移り、今度は2番目の配列のキーが返されるようになります。このように、keyメソッドは、複数のイテレータをまたいで反復処理を行う際に、現在位置のキーを正確に把握するために不可欠な機能を提供します。

Copy
1<?php
2
3$iterator1 = new ArrayIterator(['a' => 'Apple', 'b' => 'Banana']);
4$iterator2 = new ArrayIterator(['c' => 'Cherry', 'd' => 'Date']);
5
6$appendIterator = new AppendIterator();
7$appendIterator->append($iterator1);
8$appendIterator->append($iterator2);
9
10foreach ($appendIterator as $value) {
11    // 現在のイテレーションにおける要素のキーを取得して表示します
12    echo $appendIterator->key() . PHP_EOL;
13}
14
15?>

引数なし

引数はありません

mixed

AppendIterator::key() は、現在アクティブなイテレータが指す要素のキーを返します。キーは mixed 型で、イテレータの種類によって整数や文字列など、様々な型を取り得ます。