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

topメソッドは、SplStackクラスに属し、スタックの最上位にある要素を取得するメソッドです。

SplStackは、後入れ先出し（LIFO: Last-In, First-Out）の原則に基づいて要素を格納および取り出すデータ構造であるスタックを実装するクラスです。スタックの最上位とは、最も最近追加された、次に取り出される要素を指します。

このtopメソッドは、スタックから要素を削除することなく、その値だけを確認したい場合に非常に役立ちます。例えば、処理を行う前に次の要素が何であるかを確認し、その情報に基づいて条件分岐や他の操作を実行する際に利用できます。

topメソッドは引数を取りません。戻り値としては、スタックの最上位にある要素の値を返します。ただし、もしスタックが空である状態でtopメソッドを呼び出した場合、RuntimeExceptionがスローされますので、メソッドを呼び出す前にスタックが空でないことを確認することが重要です。これは、SplStack::isEmpty()メソッドを使用してチェックできます。

スタックの最上位要素を取得する目的で使われるSplStack::popメソッドとは異なり、topメソッドは要素をスタックから削除しない点が決定的な違いです。これにより、スタックの状態を維持したまま、現在処理対象となる要素を「覗き見る」ことができます。

Copy
1<?php
2$stack = new SplStack();
3$stack->push("first");
4$stack->push("second");
5$stack->push("third");
6
7$topElement = $stack->top(); // スタックの先頭要素（この場合は"third"）を取得
8echo $topElement;
9?>

引数なし

引数はありません

mixed

SplStackクラスのtopメソッドは、スタックの最上位にある要素を返します。