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

Copy
1<?php
2
3/**
4 * SplQueueのイテレータモードを設定し、その動作を確認するサンプル関数。
5 *
6 * SplQueue::setIteratorMode() メソッドは、キューを反復処理 (foreachループなど) する際の動作を制御します。
7 * 主に、要素を取り出す順序 (FIFO: 先入れ先出し / LIFO: 後入れ先出し) と、
8 * 取り出した後に要素をキューから削除するかどうかを設定できます。
9 *
10 * キーワード「php getiterator」は、SplQueueがIteratorAggregateインターフェースを実装しており、
11 * foreachループでイテレーションできることを示唆しています。
12 * setIteratorModeは、このイテレーションの振る舞いを変更するために使用されます。
13 */
14function demonstrateSplQueueIteratorMode(): void
15{
16    echo "--- SplQueue::setIteratorMode() のデモンストレーション ---\n\n";
17
18    // 1. SplQueueを作成し、要素を追加
19    $queue = new SplQueue();
20    $queue->enqueue("A"); // 最初に追加
21    $queue->enqueue("B");
22    $queue->enqueue("C"); // 最後に追加
23
24    echo "初期キューの状態: ";
25    printQueueContent($queue); // キューの現在の内容を表示するヘルパー関数
26    echo "  (要素 A, B, C が FIFO 順に並んでいます)\n\n";
27
28    // 2. デフォルトモード (FIFO:先入れ先出し, 要素保持) でイテレーション
29    // SplQueueのデフォルトのイテレータモードは IT_MODE_FIFO | IT_MODE_KEEP です。
30    // setIteratorModeを呼び出さない場合もこのモードが適用されます。
31    echo "1. デフォルトモード (FIFO:先入れ先出し, 要素保持):\n";
32    echo "   イテレーション結果: ";
33    foreach ($queue as $item) {
34        echo $item . " ";
35    }
36    echo "\n";
37    echo "   イテレーション後のキューの状態: ";
38    printQueueContent($queue);
39    echo "  (要素は保持されているため、変化なし)\n\n";
40
41    // 3. LIFOモード (後入れ先出し、要素保持) に設定し、イテレーション
42    // setIteratorModeで SplQueue::IT_MODE_LIFO フラグを設定します。
43    // IT_MODE_KEEP と組み合わせることで、要素は削除されずに保持されます。
44    $queue->setIteratorMode(SplQueue::IT_MODE_LIFO | SplQueue::IT_MODE_KEEP);
45    echo "2. LIFOモード (LIFO:後入れ先出し, 要素保持):\n";
46    echo "   イテレーション結果: ";
47    foreach ($queue as $item) {
48        echo $item . " ";
49    }
50    echo "\n";
51    echo "   イテレーション後のキューの状態: ";
52    printQueueContent($queue);
53    echo "  (要素は保持されているため、変化なし)\n\n";
54
55    // 4. FIFOモード (先入れ先出し、要素削除) に設定し、イテレーション
56    // このモードでは、foreachで要素が取り出されるたびにキューから削除されます。
57    // setIteratorModeで SplQueue::IT_MODE_DELETE フラグを設定します。
58    $queue->setIteratorMode(SplQueue::IT_MODE_FIFO | SplQueue::IT_MODE_DELETE);
59    echo "3. FIFOモード (FIFO:先入れ先出し, 要素削除):\n";
60    echo "   イテレーション結果: ";
61    foreach ($queue as $item) {
62        echo $item . " ";
63    }
64    echo "\n";
65    echo "   イテレーション後のキューの状態: ";
66    printQueueContent($queue); // キューが空になっているはず
67    echo "  (イテレーション中に要素が削除されたため、キューは空になりました)\n\n";
68}
69
70/**
71 * SplQueueの内容を分かりやすく表示するためのヘルパー関数。
72 * この関数は、一時的にイテレータモードを変更してキューの状態を取得し、
73 * 元のモードに戻すことで、キューの表示が現在のイテレータモードに影響を与えないようにします。
74 *
75 * @param SplQueue $queue 表示するキューオブジェクト
76 */
77function printQueueContent(SplQueue $queue): void
78{
79    if ($queue->isEmpty()) {
80        echo "[空]";
81        return;
82    }
83
84    $elements = [];
85    // 現在のイテレータモードを一時的に保存
86    $originalMode = $queue->getIteratorMode();
87
88    // FIFOかつ要素を保持するモードでイテレーションして要素を取得し、キューの内容に影響を与えないようにする
89    $queue->setIteratorMode(SplQueue::IT_MODE_FIFO | SplQueue::IT_MODE_KEEP);
90
91    foreach ($queue as $item) {
92        $elements[] = $item;
93    }
94    echo "[" . implode(", ", $elements) . "]";
95
96    // 元のイテレータモードに戻す
97    $queue->setIteratorMode($originalMode);
98}
99
100// サンプル関数の実行
101demonstrateSplQueueIteratorMode();
102

PHPのSplQueue::setIteratorModeメソッドは、キュー（待ち行列）オブジェクトをforeachなどのループで反復処理する際の動作を設定するために使用されます。SplQueueはIteratorAggregateインターフェースを実装しており、内部の要素を順番に処理するforeachループのようなイテレーションが可能です。このメソッドは、そのイテレーションの順序や、要素を処理した後の挙動を細かく制御します。

引数$modeには、要素を取り出す順序としてSplQueue::IT_MODE_FIFO（First-In, First-Out: 先入れ先出し）またはSplQueue::IT_MODE_LIFO（Last-In, First-Out: 後入れ先出し）のいずれかを指定します。オプションの引数$flagsには、イテレーション中に要素をキューから削除するかどうかを設定します。SplQueue::IT_MODE_KEEPを指定すると要素はキューに残りますが、SplQueue::IT_MODE_DELETEを指定するとイテレーション中に要素がキューから削除されます。これらの定数はビットOR演算子|を使って組み合わせて指定できます。このメソッドは、設定を適用するだけで特別な値を返しません。

サンプルコードでは、まずキューに要素を追加し、デフォルトのFIFOかつ要素保持モードでのイテレーションを示します。次に、setIteratorModeを使ってLIFOかつ要素保持モードに変更し、後入れ先出しで要素が取り出されることを確認しています。最後に、FIFOかつ要素削除モードを設定してイテレーションすることで、要素が取り出されると同時にキューから削除され、最終的にキューが空になる挙動を具体的に示し、各モード設定による動作の違いを明確にしています。

Copy
1<?php
2
3/**
4 * SplQueue::setIteratorMode の使用例
5 *
6 * SplQueue は PHP の標準ライブラリ (SPL) で提供されるキュー実装です。
7 * IteratorAggregate インターフェースを実装しているため、
8 * foreach ループでキューの要素を反復処理できます。
9 * setIteratorMode メソッドは、この反復処理の順序を設定するために使用します。
10 */
11
12// SplQueue のインスタンスを作成します。
13$queue = new SplQueue();
14
15// キューにいくつかの要素を追加します（先入れ先出しの順序）。
16$queue->enqueue("最初のデータ");
17$queue->enqueue("真ん中のデータ");
18$queue->enqueue("最後のデータ");
19
20echo "--- FIFO (先入れ先出し) モードでの反復処理 ---\n";
21// setIteratorMode を使用して、反復処理を FIFO (First-In, First-Out) モードに設定します。
22// これは SplQueue のデフォルトの挙動ですが、明示的に設定して動作を確認します。
23$queue->setIteratorMode(SplQueue::IT_MODE_FIFO);
24
25// foreach ループでキューの要素を反復処理します。
26// FIFO モードなので、追加した順序でデータが出力されます。
27foreach ($queue as $item) {
28    echo $item . "\n";
29}
30
31echo "\n--- LIFO (後入れ先出し) モードでの反復処理 ---\n";
32// setIteratorMode を使用して、反復処理を LIFO (Last-In, First-Out) モードに設定します。
33$queue->setIteratorMode(SplQueue::IT_MODE_LIFO);
34
35// foreach ループでキューの要素を反復処理します。
36// LIFO モードなので、追加したとは逆の順序でデータが出力されます。
37foreach ($queue as $item) {
38    echo $item . "\n";
39}
40
41// 補足: foreach ループでの反復処理では、SplQueue から要素は削除されません。
42// 要素を削除するには dequeue() メソッドを使用する必要があります。
43
44?>

PHPのSplQueueは、データを一時的に保存し、特定の順序で取り出すためのキュー（待ち行列）というデータ構造を提供するクラスです。SplQueueはIteratorAggregateインターフェースを実装しており、foreachループを使ってその要素を簡単に反復処理できます。

setIteratorModeメソッドは、このforeachループでの反復処理の順序を設定するために使用します。引数には整数型の$modeを指定します。例えば、SplQueue::IT_MODE_FIFOを指定すると、要素はキューに追加された順序（先入れ先出し、First-In, First-Out）で取り出されます。これはキューの基本的な動作です。一方、SplQueue::IT_MODE_LIFOを指定すると、要素は追加された順序とは逆の順序（後入れ先出し、Last-In, First-Out）で取り出されます。オプションの引数$flagsは通常省略され、このメソッド自体は戻り値を返しません。

サンプルコードでは、まずSplQueueに「最初のデータ」「真ん中のデータ」「最後のデータ」の順で要素を追加しています。setIteratorMode(SplQueue::IT_MODE_FIFO)を設定してforeachで処理すると、追加した通りの順序でデータが表示されます。次にsetIteratorMode(SplQueue::IT_MODE_LIFO)に変更してforeachで処理すると、「最後のデータ」「真ん中のデータ」「最初のデータ」という逆順でデータが表示されることが確認できます。このように、同じキューの中身でも、反復処理の順序を柔軟に変更できるのがこのメソッドの役割です。なお、foreachループでの反復処理はキューから要素を削除するものではなく、要素を削除するにはdequeue()メソッドを使用する必要があります。