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

Copy
1<?php
2
3/**
4 * SplQueue::rewind の使用例
5 *
6 * SplQueue は、PHPの標準ライブラリ (SPL) で提供される、両端キューの実装です。
7 * このクラスは Iterator インターフェースを実装しているため、foreach ループで要素を順に処理できます。
8 *
9 * rewind メソッドは、イテレータの内部ポインタをキューの先頭に戻すために使用されます。
10 * これにより、一度 foreach ループで最後まで処理した SplQueue オブジェクトを、
11 * 再び先頭から複数回イテレートすることが可能になります。
12 *
13 * 通常のジェネレータは一度しかイテレートできませんが、SplQueue のようなデータ構造は
14 * rewind メソッドによって「巻き戻し可能」なイテレーションを提供します。
15 */
16function demonstrateSplQueueRewind(): void
17{
18    // SplQueue のインスタンスを作成します
19    $queue = new SplQueue();
20
21    // キューに要素を追加します (enqueue)
22    echo "--- 要素をキューに追加中 ---\n";
23    $queue->enqueue("データ A");
24    $queue->enqueue("データ B");
25    $queue->enqueue("データ C");
26    echo "現在のキューの要素数: " . $queue->count() . "\n\n";
27
28    // 最初の foreach ループでキューの要素を処理します。
29    // SplQueue は Iterator を実装しているため、自動的にイテレータが先頭に設定されます。
30    echo "--- 最初のイテレーション ---\n";
31    foreach ($queue as $item) {
32        echo "処理中の要素: " . $item . "\n";
33    }
34    echo "最初のイテレーション完了。イテレータは終端にあります。\n\n";
35
36    // この時点でイテレータのポインタはキューの終端に達しているため、
37    // 再度 foreach ループを実行しても何も出力されません (要素が残っていないため)。
38
39    // rewind() メソッドを呼び出して、イテレータのポインタをキューの先頭に戻します。
40    echo "--- rewind() を呼び出し、イテレータを先頭に巻き戻し ---\n\n";
41    $queue->rewind();
42
43    // 2回目の foreach ループでキューの要素を処理します。
44    // rewind() のおかげで、再度先頭から要素を読み込むことができます。
45    echo "--- 2回目のイテレーション ---\n";
46    foreach ($queue as $item) {
47        echo "再度処理中の要素: " . $item . "\n";
48    }
49    echo "2回目のイテレーション完了。\n\n";
50
51    // キューから要素を取り出します (dequeue)
52    echo "--- キューから要素を取り出し (dequeue) ---\n";
53    echo "取り出した要素: " . $queue->dequeue() . "\n";
54    echo "現在のキューの要素数: " . $queue->count() . "\n\n";
55
56    // 再度 rewind してイテレートしてみます (dequeue された要素は含まれません)。
57    echo "--- 3回目のイテレーション (dequeue 後) ---\n";
58    $queue->rewind();
59    foreach ($queue as $item) {
60        echo "残りの要素: " . $item . "\n";
61    }
62    echo "3回目のイテレーション完了。\n";
63}
64
65// 関数を実行して動作を確認します
66demonstrateSplQueueRewind();

SplQueue::rewindメソッドは、PHP 8で利用できる標準ライブラリ（SPL）のSplQueueクラスに属する機能です。SplQueueは、データを順番に管理する待ち行列（キュー）の実装であり、Iteratorインターフェースを実装しているため、foreachループで内部の要素を順次処理できます。

このrewindメソッドは、引数を一切取らず、戻り値もありません。その役割は、SplQueueオブジェクトのイテレータの内部ポインタを、キューの先頭位置にリセットすることです。通常、foreachループなどでキューの全要素を一度処理すると、イテレータのポインタは終端に達します。そのため、そのままでは再度foreachを実行しても要素は処理されません。

サンプルコードでは、最初に要素を追加したキューを一度目のforeachで処理した後、rewind()メソッドを呼び出しています。これにより、イテレータがキューの先頭に「巻き戻され」、二度目のforeachループでも再び全ての要素を先頭から順に処理できるようになります。このように、rewindメソッドを使うことで、SplQueueは通常のジェネレータが一度しかイテレートできないのに対し、複数回にわたって「巻き戻し可能」なイテレーションを提供するデータ構造として機能します。