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

bottomメソッドは、SplStackクラスにおけるスタックの最下位（一番最初にスタックに追加された）要素を取得するメソッドです。

SplStackは、後から追加した要素を先に取り出す「後入れ先出し（LIFO：Last In, First Out）」の原則に従うデータ構造であるスタックを実装しています。スタックは、皿を重ねるように要素を積み重ね、一番上の要素から順に取り出すイメージです。

このbottomメソッドは、スタックの一番底にある要素、つまり最も古い要素を参照する際に使用します。特長としては、要素を取得するだけで、スタックからその要素を削除しない点です。一般的なスタック操作である「pop」は最上位の要素を削除して取り出しますが、bottomメソッドはスタックの構造を変えることなく、最下位の要素の値のみを提供します。

例えば、スタックにA、B、Cの順で要素を追加した場合、Aが最下位、Cが最上位となります。このメソッドを呼び出すと「A」が返されます。データ構造の整合性を保ちつつ、最古の情報を確認したい場合に非常に役立ちます。ただし、対象のSplStackが空の場合にこのメソッドを呼び出すと、RuntimeExceptionが発生するため、利用する際にはスタックが空でないかを確認する処理を組み込むことが推奨されます。

Copy
1<?php
2$stack = new SplStack();
3$stack->push('Element A');
4$stack->push('Element B');
5$stack->push('Element C');
6
7// スタックの一番下の要素（最初にプッシュされた要素）を取得する
8$bottomElement = $stack->bottom();
9echo $bottomElement;
10?>

引数なし

引数はありません

mixed

SplStack の一番下にある要素を返します。