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

unshiftメソッドは、SplQueueクラスに属し、キューの先頭に新しい要素を追加するメソッドです。SplQueueは、主にデータの順序を保持する「キュー」というデータ構造をPHPで扱うためのクラスで、通常は先に入れたものが先に出される（FIFO: First-In, First-Out）という原則で動作します。

このunshiftメソッドは、その原則とは異なり、引数として指定された値をキューの「一番前」に挿入します。これにより、後から追加された要素であっても、他の既存の要素よりも先に処理されるように設定できます。SplQueueクラスには、キューの末尾に要素を追加するpushメソッドも存在しますが、unshiftメソッドはpushメソッドと対照的な操作であり、キューのフロント（先頭）に直接要素を挿入する点が特徴です。

これにより、SplQueueは単なるキューとしてだけでなく、要素を先頭から取り出し、先頭に追加するというスタック（LIFO: Last-In, First-Out）のような振る舞いも実現できるようになります。unshiftメソッドは、追加したい値そのものを引数として受け取り、戻り値は特にありません（void型です）。例えば、緊急性の高い処理を優先的に実行したい場合など、既存のキューの処理順序に割り込んで最優先で処理すべきデータを追加する際に非常に有用です。

Copy
1<?php
2$queue = new SplQueue();
3$queue->unshift('value1', 'value2', 'value3');
4?>

mixed $value

• mixed $value: キューの先頭に追加したい値。任意の値型を指定できます。

戻り値なし

戻り値はありません