【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は通常のジェネレータが一度しかイテレートできないのに対し、複数回にわたって「巻き戻し可能」なイテレーションを提供するデータ構造として機能します。

Copy
1<?php
2
3/**
4 * SplQueue::rewind メソッドの動作を実演する関数。
5 * この関数は、SplQueue に要素を追加し、一度イテレーション（ループ）した後、
6 * rewind() メソッドを使用してイテレータをキューの先頭に巻き戻し、再度イテレーションします。
7 *
8 * SplQueue は、先入れ先出し (FIFO) のデータ構造ですが、Iterator インターフェースを実装しているため、
9 * foreach ループで要素を順に処理できます。rewind() メソッドは、このイテレータの内部ポインタを
10 * 最初の要素の位置に戻すために使用されます。
11 *
12 * @return void
13 */
14function demonstrateSplQueueRewind(): void
15{
16    // SplQueue オブジェクトを初期化
17    $queue = new SplQueue();
18
19    // キューにいくつかの要素を追加
20    $queue->enqueue("タスク A");
21    $queue->enqueue("タスク B");
22    $queue->enqueue("タスク C");
23
24    echo "--- 最初のイテレーション（キューを一度処理）---\n";
25    // 最初の foreach ループでキューの要素を順に処理
26    // このループが終了すると、イテレータの内部ポインタはキューの終端にあります。
27    foreach ($queue as $item) {
28        echo "処理中: " . $item . "\n";
29    }
30
31    echo "\n--- SplQueue::rewind() を実行 ---\n";
32    // rewind() メソッドを呼び出すことで、イテレータの内部ポインタをキューの先頭に戻します。
33    // これにより、キューを最初から再度イテレーションできるようになります。
34    $queue->rewind();
35    echo "SplQueue::rewind() が呼び出され、イテレータが先頭に巻き戻されました。\n";
36
37    echo "\n--- 2回目のイテレーション（rewind() の効果を確認）---\n";
38    // 2回目の foreach ループでキューの要素を順に処理
39    // rewind() の効果により、最初のループと同じ順序で要素が再度処理されます。
40    foreach ($queue as $item) {
41        echo "再処理中: " . $item . "\n";
42    }
43
44    echo "\nSplQueue::rewind() メソッドのデモンストレーションが完了しました。\n";
45}
46
47// 関数を実行して動作を確認
48demonstrateSplQueueRewind();

PHP 8のSplQueueクラスは、データを先に入れたものから順に取り出す（先入れ先出し、FIFO）キューというデータ構造を扱います。このSplQueueは、Iteratorインターフェースを実装しているため、foreachループを使ってキューの要素を一つずつ順に処理することができます。

SplQueue::rewindメソッドは、このイテレータの内部ポインタをキューの「先頭」に巻き戻す役割を持ちます。つまり、一度foreachループなどでキューの要素を最後まで処理し終えた後でも、このrewindメソッドを呼び出すことで、再びキューの最初の要素から処理を始めることができるようになります。

このメソッドは引数を一切受け取らず、特定の値を返すこともありません。サンプルコードでは、まずキューに「タスク A」「タスク B」「タスク C」を追加し、最初のforeachループでこれらを順に処理します。ループ終了後、rewindメソッドを呼び出すことで、イテレータのポインタが「タスク A」の位置に戻されます。その結果、2回目のforeachループでは、再び「タスク A」から順番に要素が処理され、rewindの効果が明確に示されています。

Copy
1<?php
2
3/**
4 * SplQueue::rewind メソッドのデモンストレーションを行う関数。
5 *
6 * SplQueue は、PHP の Standard PHP Library (SPL) の一部で、
7 * キュー（先入れ先出しのコレクション）を実装するクラスです。
8 * Iterator インターフェースを実装しているため、foreach ループでイテレートできます。
9 *
10 * SplQueue::rewind() メソッドは、イテレータの内部ポインタをキューの先頭に戻します。
11 * これにより、キューの要素を最初から再度イテレートできるようになります。
12 */
13function demonstrateSplQueueRewind(): void
14{
15    // SplQueue の新しいインスタンスを作成
16    $queue = new SplQueue();
17
18    // キューにいくつかの要素を追加
19    $queue->enqueue('データA');
20    $queue->enqueue('データB');
21    $queue->enqueue('データC');
22
23    echo "--- キューの最初のイテレーション ---\n";
24    // 最初のイテレーションでキューの要素を出力
25    foreach ($queue as $item) {
26        echo "取得要素: " . $item . "\n";
27    }
28
29    // イテレータの内部ポインタをキューの先頭に巻き戻します。
30    // これにより、次にイテレートする際にキューの最初から開始されます。
31    $queue->rewind();
32
33    echo "\n--- キューの2回目のイテレーション (rewind()後) ---\n";
34    // 2回目のイテレーションでキューの要素を再度出力
35    // rewind() メソッドが正しく機能し、最初から再度イテレートされていることを示します。
36    foreach ($queue as $item) {
37        echo "取得要素: " . $item . "\n";
38    }
39
40    echo "\nSplQueue::rewind() のデモンストレーションが完了しました。\n";
41}
42
43// 関数を実行してデモンストレーションを開始
44demonstrateSplQueueRewind();

このサンプルコードは、PHP 8で利用できるSplQueueクラスのrewindメソッドの働きを示しています。SplQueueは、PHPの標準ライブラリ（SPL）の一部であり、キュー（先入れ先出し）と呼ばれるデータ構造を実装したクラスです。このクラスはIteratorインターフェースを実装しているため、foreachループを使ってキュー内の要素を順番に処理できます。

SplQueue::rewind()メソッドは、イテレータの内部ポインタをキューの先頭に巻き戻す（リセットする）ために使用されます。このメソッドは引数を必要とせず、特定の戻り値もありません。一度呼び出されると、次にforeachなどでキューをイテレートする際に、一番最初の要素から処理が再度開始されるようになります。

コードではまず、SplQueueにいくつかのデータを追加し、最初のforeachループでそれらの要素を順に表示しています。この時点でイテレータのポインタはキューの終端にあります。その後、$queue->rewind();を呼び出すことで、イテレータのポインタがキューの先頭に戻されます。これにより、2回目のforeachループを実行すると、再び最初の要素から順にデータが表示され、rewind()メソッドが正しく機能していることが確認できます。