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

offsetGetメソッドは、SplStackクラスに格納されている特定の要素を取得するメソッドです。SplStackクラスは、データを「最後に入れたものが最初に出てくる（LIFO: Last In, First Out）」という原則に基づいて管理するスタックというデータ構造を実装しています。通常、スタックは一番上（トップ）の要素のみを操作しますが、offsetGetメソッドを使用すると、スタック内の任意の場所にアクセスし、その位置にある要素を取り出すことが可能です。

このメソッドは、引数として指定されたオフセット（インデックス）に基づいて要素を返します。オフセット0はスタックの底、つまり最も古い要素を指し、オフセット1は次に古い要素を指します。また、負のオフセットも利用可能で、例えば-1はスタックのトップ、つまり最も新しい要素を指します。これにより、配列のようにインデックスを使ってスタック内のデータにアクセスできる柔軟性が提供されます。offsetGetメソッドは、指定されたオフセットに存在する要素の値を返しますが、その要素がスタックから削除されることはありません。スタック内のデータを削除せずに内容を確認したい場合に役立ちます。

Copy
1<?php
2$stack = new SplStack();
3$stack->push("First Item");
4$stack->push("Second Item");
5$stack->push("Third Item");
6
7$value = $stack->offsetGet(0);
8?>

int $index

• int $index: 取得したい要素のインデックスを指定する整数

mixed

SplStackのoffsetGetメソッドは、指定されたインデックス（キー）に対応する要素の値を返します。