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

dequeueメソッドは、PHPのSplQueueクラスに定義されており、キューの先頭から要素を取り出す操作を実行するメソッドです。SplQueueは、Standard PHP Library (SPL) の一部として提供される、データを先入れ先出し（FIFO: First-In, First-Out）の原則で管理する線形データ構造、すなわちキューを効率的に実装するためのクラスです。

このメソッドを呼び出すと、キュー内で最も古い、つまり最初に追加された要素が取得されます。同時に、取得された要素はキューから削除され、キューのサイズは1つ減少します。取り出された要素の値は、このメソッドの戻り値として返されます。

キューが空の状態でdequeueを呼び出すと、RuntimeExceptionがスローされます。そのため、要素を取り出す前にはisEmpty()メソッドなどでキューが空でないことを確認することが重要です。このメソッドは、メッセージの処理順序の保証やタスクの順番処理など、FIFOの特性が求められる様々な場面で利用されます。

Copy
1<?php
2$queue = new SplQueue();
3$queue->enqueue("element_one");
4$queue->enqueue("element_two");
5
6$dequeuedElement = $queue->dequeue();
7?>

引数なし

引数はありません

mixed

SplQueueクラスのdequeueメソッドは、キューの先頭から要素を1つ取り出し、その要素の値を返します。キューが空の場合は、nullを返します。