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

bottomメソッドは、SplDoublyLinkedListの最下部、すなわちリストの最初の要素を取得するメソッドです。このメソッドが所属するSplDoublyLinkedListクラスは、PHPの標準拡張機能であるSPL（Standard PHP Library）が提供するデータ構造の一つで、要素を双方向に連結して保持するリストです。要素の追加や削除、特定の要素へのアクセスを効率的に行うことができます。

bottomメソッドを呼び出すと、リストに最初に追加された要素、すなわちリストの最下部に位置する要素が返されます。もしリストが空である場合、このメソッドはRuntimeExceptionを発生させますので、メソッドを呼び出す前にisEmpty()メソッドなどでリストが空でないことを確認することが推奨されます。

このメソッドは、リストの内部イテレータポインタを移動させません。したがって、現在のポインタ位置に影響を与えることなく、リストの最初の要素を参照することができます。主に、リストの先頭要素の内容を素早く確認したい場合や、リストのデータ処理の起点として最初の要素を参照したい場合に利用されます。リストの要素を順次処理したい場合は、rewind()メソッドでポインタを先頭に戻し、current()やnext()メソッドと組み合わせてイテレータとして利用することが一般的ですが、bottom()メソッドはポインタの状態とは独立して最初の要素にアクセスできる点が特徴です。

Copy
1<?php
2$list = new SplDoublyLinkedList();
3$list->push('Apple');
4$list->push('Banana');
5$list->push('Cherry');
6
7$firstElement = $list->bottom();
8echo $firstElement;
9?>

引数なし

引数はありません

mixed

SplDoublyLinkedList::bottom は、リストの末尾の要素を返します。リストが空の場合は null を返します。