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

getIteratorModeメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2026年01月08日

基本的な使い方

getIteratorModeメソッドは、SplQueueクラスのインスタンスが、その内部の要素を順に処理する際の現在のモードを取得するメソッドです。SplQueueは、PHPの標準ライブラリ（SPL）が提供するクラスで、キュー（待ち行列）と呼ばれるデータ構造を扱います。キューは「先入れ先出し」（FIFO: First-In, First-Out）という原則に基づき、要素が追加された順に取り出される特徴を持っています。

このメソッドが取得する「イテレータモード」とは、SplQueueの要素をforeach文などで反復処理する際に、どのように振る舞うかを定義する設定のことです。例えば、要素を反復処理中にキューから削除するか（SplQueue::IT_MODE_DELETE）、それとも削除せずに保持するか（SplQueue::IT_MODE_KEEP）といった動作を制御できます。getIteratorModeメソッドは、これらのモード設定を表す整数値を返します。この整数値は、複数のモード設定がビットマスクとして組み合わされたものです。

このメソッドを利用することで、現在のSplQueueオブジェクトがどのようなイテレータの振る舞いに設定されているかをプログラム上で確認できます。これは、特にイテレータの動作が期待通りになっているかをデバッグしたり、実行時に動的に処理を分岐させたりする際に役立ちます。通常、setIteratorModeメソッドでイテレータモードを設定し、getIteratorModeメソッドでその設定が正しく行われたかを確認する、という流れで使用されます。

構文(syntax)


1<?php
2
3$queue = new SplQueue();
4$iteratorMode = $queue->getIteratorMode();
5var_dump($iteratorMode);
6
7?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

SplQueue::getIteratorMode()は、キューのイテレーションモードを表す整数を返します。この整数は、SplQueue::ITERATE_MODE_FIFO (先進出FIFO)またはSplQueue::ITERATE_MODE_LIFO (後入先出LIFO)のいずれかです。