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

bottomメソッドは、SplQueueクラスに属し、キューの末尾にある要素を取得するメソッドです。SplQueueは、PHPの標準拡張機能であるSPL（Standard PHP Library）が提供する、先入れ先出し（FIFO: First-In, First-Out）の原則に基づいたデータ構造であるキューを実装したクラスです。このbottomメソッドは、キューに追加された要素のうち、最も後に追加され、まだ取り出されていない要素を返します。具体的には、キューの最も「底」にある要素を取得する際に使用されます。キューの先頭、つまり次に取り出される要素を取得するtopメソッドとは異なり、bottomメソッドはキューの最後尾の要素を対象とします。このメソッドは引数を取りません。戻り値はキューの末尾の要素であり、その型はキューに格納されている要素の型によって異なります（mixed型）。もしキューが空の状態でbottomメソッドを呼び出すと、RuntimeExceptionがスローされます。そのため、メソッドを呼び出す前にisEmptyメソッドなどを用いてキューが空でないかを確認することが、予期せぬエラーを防ぐ上で推奨されます。このメソッドを利用することで、キューの操作順序に影響を与えることなく、末尾の要素の内容を安全に確認することができます。

Copy
1<?php
2
3$queue = new SplQueue();
4$queue->enqueue("最初の要素");
5$queue->enqueue("二番目の要素");
6$queue->enqueue("三番目の要素");
7
8// キューの底（最初に追加された要素）を取得します
9$bottomElement = $queue->bottom();
10
11var_dump($bottomElement);
12
13?>

引数なし

引数はありません

mixed

SplQueue クラスの bottom メソッドは、キューの末尾（一番最後に追加された要素）の値を返します。