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

keyメソッドは、SplStackオブジェクトにおいて、現在アクティブな要素のインデックスを取得するメソッドです。SplStackは、LIFO（Last In, First Out）の原則に基づき、最後に追加された要素が最初に取得されるスタックデータ構造を実装しています。

このメソッドは、SplStackオブジェクトをforeachループなどで反復処理している際に、現在処理している要素がスタック内で何番目の要素であるかを示す、0から始まる整数値のインデックスを返します。このインデックスは、要素がスタックにpushされた際に割り当てられる論理的な順番に対応しており、最初に追加された要素が0、次に追加された要素が1といった具合に値が増加します。

たとえば、スタックの要素を巡回しながら、その要素が元々スタックにどの位置で追加されたのかを把握したい場合や、スタックの特定の深さにある要素を識別したい場合にkeyメソッドが役立ちます。このメソッドは、スタックの反復処理中に現在の位置情報を正確に取得したい場合に有用です。

Copy
1<?php
2$stack = new SplStack();
3$stack->push('elementA');
4$stack->push('elementB');
5$stack->rewind(); // イテレータをスタックのトップ（最新の要素）に設定
6
7$currentIndex = $stack->key(); // 現在の要素の0から始まるインデックスを取得
8?>

引数なし

引数はありません

int

SplStack::key() は、現在の要素のキー（インデックス）を整数値で返します。