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

shiftメソッドは、SplQueueオブジェクトの先頭から要素を取り除き、その要素を返すメソッドです。SplQueueは、データが追加された順番に処理される「キュー」（先入れ先出し、FIFO: First-In, First-Out）というデータ構造を実装するためのクラスです。このshiftメソッドは、キューの最も古い要素、つまり最初に追加された要素をキューから取り出し、同時にその要素を返します。これにより、キューに格納された複数のタスクやデータなどを、追加された順に一つずつ処理していく場面で非常に役立ちます。例えば、メッセージキューから未処理のメッセージを順番に取り出して処理する場合などに利用されます。もし、キューが空の状態でshiftメソッドを呼び出した場合、RuntimeExceptionが発生します。そのため、メソッドを呼び出す前にSplQueue::isEmpty()メソッドやSplQueue::count()メソッドを使用して、キューに要素が存在するかどうかを確認することをお勧めします。

Copy
1<?php
2$queue = new SplQueue();
3$queue->push("data1");
4$queue->push("data2");
5
6$removedElement = $queue->shift();
7?>

引数なし

引数はありません

mixed

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