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

Copy
1<?php
2
3/**
4 * SplQueue のイテレータモードを取得するサンプルコードです。
5 *
6 * SplQueue は、データの追加（enqueue）と削除（dequeue）を効率的に行えるキュー（待ち行列）を扱うクラスです。
7 * getIteratorMode() メソッドは、SplQueue を foreach ループなどでイテレート（巡回）する際の
8 * データの取り出し順序を整数値で返します。
9 *
10 * 主なモード:
11 * - SplDoublyLinkedList::IT_MODE_FIFO (1): First-In, First-Out（最初に入れたものが最初に出てくる、通常のキュー）
12 * - SplDoublyLinkedList::IT_MODE_LIFO (2): Last-In, First-Out（最後に入れたものが最初に出てくる、スタックのような動作）
13 */
14
15// 1. 新しい SplQueue のインスタンスを作成します。
16$queue = new SplQueue();
17
18// 2. 現在のイテレータモードを取得し、表示します。
19//    SplQueue のデフォルトのイテレータモードは FIFO (First-In, First-Out) です。
20$initialMode = $queue->getIteratorMode();
21echo "現在のイテレータモード (数値): " . $initialMode . PHP_EOL;
22
23// 取得した数値がどのモードに対応するかを説明します。
24// SplQueue は SplDoublyLinkedList を継承しているため、その定数を使用します。
25if ($initialMode === SplDoublyLinkedList::IT_MODE_FIFO) {
26    echo "  -> 意味: FIFO (First-In, First-Out) モードです。" . PHP_EOL;
27} elseif ($initialMode === SplDoublyLinkedList::IT_MODE_LIFO) {
28    echo "  -> 意味: LIFO (Last-In, First-Out) モードです。" . PHP_EOL;
29} else {
30    echo "  -> 意味: 不明なモードです。" . PHP_EOL;
31}
32echo PHP_EOL;
33
34// 3. イテレータモードを LIFO (Last-In, First-Out) に変更してみます。
35//    setIteratorMode() メソッドを使ってモードを設定できます。
36$queue->setIteratorMode(SplDoublyLinkedList::IT_MODE_LIFO);
37echo "イテレータモードを LIFO に変更しました。" . PHP_EOL;
38echo PHP_EOL;
39
40// 4. 変更後のイテレータモードを再度取得し、表示します。
41$newMode = $queue->getIteratorMode();
42echo "変更後のイテレータモード (数値): " . $newMode . PHP_EOL;
43
44if ($newMode === SplDoublyLinkedList::IT_MODE_FIFO) {
45    echo "  -> 意味: FIFO (First-In, First-Out) モードです。" . PHP_EOL;
46} elseif ($newMode === SplDoublyLinkedList::IT_MODE_LIFO) {
47    echo "  -> 意味: LIFO (Last-In, First-Out) モードです。" . PHP_EOL;
48} else {
49    echo "  -> 意味: 不明なモードです。" . PHP_EOL;
50}
51
52?>

PHPのSplQueueは、データの追加と削除を効率的に行える「キュー」（待ち行列）を扱うためのクラスです。このサンプルコードは、SplQueueが提供するgetIteratorModeメソッドの使用方法を示しています。

getIteratorModeメソッドは、SplQueueの要素をforeachループなどで順に処理（イテレート）する際に、データがどのような順序で取り出されるかを示す整数値を返します。このメソッドは引数を取らず、戻り値として現在のイテレータモードを表すint型の数値を提供します。

返される主な数値は、SplDoublyLinkedList::IT_MODE_FIFO（1）とSplDoublyLinkedList::IT_MODE_LIFO（2）です。IT_MODE_FIFOは、キューに最初に入れたものが最初に取り出される「先入れ先出し」を意味し、IT_MODE_LIFOは最後に入れたものが最初に取り出される「後入れ先出し」を意味します。

サンプルコードでは、まず新しいSplQueueインスタンスを作成し、getIteratorModeで初期のモード（デフォルトはFIFO）を取得してその意味を表示しています。次に、setIteratorModeメソッドを使ってイテレータモードをLIFOに変更し、再度getIteratorModeを呼び出すことで、モードが正しく変更されたことを確認しています。これにより、キューの巡回順序を柔軟に設定できることが理解できます。

Copy
1<?php
2
3/**
4 * SplQueue のイテレータモードの取得と、その動作を実演するサンプルコードです。
5 *
6 * SplQueue は IteratorAggregate インターフェースを実装しており、
7 * foreach ループを使ってキューの要素を反復処理することができます。
8 * getIteratorMode() メソッドは、現在の反復処理の挙動設定（FIFO/LIFO、要素の削除有無）を
9 * 整数値として取得します。
10 */
11function demonstrateSplQueueIteratorMode(): void
12{
13    // SplQueue インスタンスを作成します
14    $queue = new SplQueue();
15
16    // キューにいくつかの要素を追加します
17    echo "--- 要素を追加 ---\n";
18    $queue->enqueue('データA');
19    $queue->enqueue('データB');
20    $queue->enqueue('データC');
21    echo "現在のキューの要素数: " . $queue->count() . "\n\n";
22
23    // 現在のイテレータモードを取得して表示します
24    // デフォルトモードは SplQueue::IT_MODE_FIFO | SplQueue::IT_MODE_DELETE
25    // （FIFO順で反復し、反復した要素をキューから削除する）
26    $currentMode = $queue->getIteratorMode();
27    echo "--- 現在のイテレータモード (デフォルト) ---\n";
28    echo "取得モード値: " . $currentMode . "\n";
29    echo "FIFOモードか？: " . (($currentMode & SplQueue::IT_MODE_FIFO) ? 'はい' : 'いいえ') . "\n";
30    echo "要素削除モードか？: " . (($currentMode & SplQueue::IT_MODE_DELETE) ? 'はい' : 'いいえ') . "\n\n";
31
32    // デフォルトモードでの反復処理を実行します
33    // 要素はFIFO（先入れ先出し）順で取り出され、キューから削除されます
34    echo "--- デフォルトモード (FIFO, 要素削除あり) での反復処理 ---\n";
35    echo "反復処理前のキューの要素数: " . $queue->count() . "\n";
36    foreach ($queue as $item) {
37        echo "取り出した要素: " . $item . "\n";
38    }
39    echo "反復処理後のキューの要素数: " . $queue->count() . "\n\n"; // すべての要素が削除されたため、0になります
40
41    // キューに再度要素を追加し、別のモードでの動作を確認します
42    echo "--- 要素を再度追加 ---\n";
43    $queue->enqueue('アイテムX');
44    $queue->enqueue('アイテムY');
45    $queue->enqueue('アイテムZ');
46    echo "現在のキューの要素数: " . $queue->count() . "\n\n";
47
48    // イテレータモードを変更します
49    // 今回は SplQueue::IT_MODE_LIFO （LIFO順で反復し、要素を削除しない）に設定します
50    $newMode = SplQueue::IT_MODE_LIFO;
51    $queue->setIteratorMode($newMode);
52
53    // 変更後のイテレータモードを再度取得して表示します
54    $changedMode = $queue->getIteratorMode();
55    echo "--- 変更後のイテレータモード ---\n";
56    echo "取得モード値: " . $changedMode . "\n";
57    echo "FIFOモードか？: " . (($changedMode & SplQueue::IT_MODE_FIFO) ? 'はい' : 'いいえ') . "\n";
58    echo "LIFOモードか？: " . (($changedMode & SplQueue::IT_MODE_LIFO) ? 'はい' : 'いいえ') . "\n";
59    echo "要素削除モードか？: " . (($changedMode & SplQueue::IT_MODE_DELETE) ? 'はい' : 'いいえ') . "\n\n";
60
61    // 変更後のモードでの反復処理を実行します
62    // 要素はLIFO（後入れ先出し）順で取り出されますが、キューからは削除されません
63    echo "--- 変更後モード (LIFO, 要素削除なし) での反復処理 ---\n";
64    echo "反復処理前のキューの要素数: " . $queue->count() . "\n";
65    foreach ($queue as $item) {
66        echo "取り出した要素: " . $item . "\n";
67    }
68    echo "反復処理後のキューの要素数: " . $queue->count() . "\n\n"; // 要素は削除されていないため、元の数に戻ります
69}
70
71// 関数を実行します
72demonstrateSplQueueIteratorMode();

PHPのSplQueueクラスは、データ構造の一つであるキュー（待ち行列）を扱うためのクラスです。このクラスはIteratorAggregateインターフェースを実装しているため、foreachループを使ってキューの要素を簡単に順番に取り出して処理できます。

SplQueue::getIteratorModeメソッドは、このforeachループで要素を反復処理する際の挙動（イテレータモード）を整数値として取得します。このメソッドに引数はなく、現在の設定を示すint型の値が戻り値となります。戻り値の整数値は、要素の取り出し順序（先入れ先出しのFIFOか、後入れ先出しのLIFOか）と、反復処理中にキューから要素を削除するかどうか、という二つの設定を表す定数（例: SplQueue::IT_MODE_FIFO、SplQueue::IT_MODE_DELETEなど）の組み合わせです。

サンプルコードではまず、キューに要素を追加し、getIteratorModeでデフォルトのイテレータモードを取得しています。デフォルトではFIFO順で要素が取り出され、取り出された要素はキューから削除されるため、foreach実行後にはキューが空になります。次に、setIteratorModeメソッドでモードをLIFOかつ要素を削除しない設定に変更し、再度getIteratorModeで変更後のモード値を確認しています。この変更後のモードでforeachを実行すると、要素はLIFO順で取り出されますが、キューからは削除されないため、foreach実行後もキューには要素が残ります。このように、getIteratorModeは現在のイテレータの挙動をプログラムで確認する際に利用されます。