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

topメソッドは、PHPのSplDoublyLinkedListオブジェクトの先頭要素を取得するメソッドです。SplDoublyLinkedListは、PHPの標準ライブラリ（SPL）が提供するクラスで、要素を効率的に両方向から追加・削除できる二重連結リストのデータ構造を実装しています。

このtopメソッドは、リストの最も先頭にある要素の値を返しますが、その要素はリストから削除されず、引き続きリストの先頭として保持されます。これは、例えばキュー（待ち行列）やスタック（積み重ね）のようなデータ構造において、次に処理すべき要素が何であるかを「見る」だけで、まだリストから取り除きたくない場合に非常に有用です。

使用する際には注意が必要です。もしSplDoublyLinkedListオブジェクトが要素を一つも持っていない、つまりリストが空の状態でtopメソッドを呼び出すと、プログラムの実行を中断するRuntimeExceptionが発生します。そのため、topメソッドを呼び出す前には、SplDoublyLinkedList::isEmpty()メソッドを用いてリストが空でないかを確認し、必要に応じて処理を分岐させることが推奨されます。このメソッドは、リストに格納されている数値、文字列、オブジェクトなど、あらゆる型のデータを返す可能性があります。

Copy
1<?php
2
3$list = new SplDoublyLinkedList();
4$list->push('element1');
5$list->push('element2');
6$list->unshift('element0'); // リストの先頭に 'element0' を追加
7
8$firstElement = $list->top(); // リストの先頭の要素を取得
9echo $firstElement; // 出力: element0
10
11?>

引数なし

引数はありません

mixed

SplDoublyLinkedListの先頭の要素を返します。