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

shiftメソッドは、SplStackオブジェクトに格納された要素のうち、スタックの底、つまり最も最初に追加された要素を取り出し、削除するメソッドです。SplStackは通常、最後に追加された要素を最初に取り出すLIFO（Last-In, First-Out）の原則に基づいて動作しますが、shiftメソッドはこれとは異なり、最初に格納された要素にアクセスします。

このメソッドは、取り出された要素を戻り値として返します。要素が取り出されると、その要素はSplStackから完全に削除されます。例えば、SplStackに格納されたタスクの履歴データから最も古い項目を削除しながら順番に処理を進める場合など、SplStackをキュー（FIFO: First-In, First-Out）のように扱いたい特定の状況で利用できる可能性があります。

スタックが空の状態でshiftメソッドを呼び出した場合、取り出すべき要素が存在しないため、通常はRuntimeExceptionなどの例外が発生します。そのため、メソッドを呼び出す前にはisEmpty()メソッドなどでスタックが空でないかを確認することが推奨されます。

Copy
1<?php
2$stack = new SplStack();
3$stack->push('first element');
4$shiftedElement = $stack->shift();
5?>

引数なし

引数はありません

mixed

SplStackクラスのshiftメソッドは、スタックの先頭（最も古い要素）から要素を取り出し、その要素を返します。