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

Copy
1<?php
2
3/**
4 * SplStack::rewind メソッドの利用例
5 *
6 * SplStack は LIFO (Last-In, First-Out) のデータ構造で、
7 * Iterator インターフェースを実装しているため、foreach ループで反復可能です。
8 *
9 * rewind() メソッドは、イテレータを最初の要素に戻すために使用されます。
10 * これにより、同じ SplStack インスタンスを複数回反復処理できるようになります。
11 * PHPの foreach ループは、開始時にイテレータの rewind() メソッドを自動的に呼び出します。
12 * 明示的に rewind() を呼び出すことで、途中で中断したイテレーションを再開したり、
13 * Iterator を直接操作する際に利用できます。
14 */
15function demonstrateSplStackRewind(): void
16{
17    // SplStack インスタンスを作成
18    $stack = new SplStack();
19
20    // スタックに要素を追加
21    // SplStack は LIFO なので、'Third Item' が最初にイテレートされます。
22    $stack->push('First Item');
23    $stack->push('Second Item');
24    $stack->push('Third Item');
25
26    echo "--- 最初のイテレーション (LIFO順) ---\n";
27    // foreach ループは自動的に rewind() を呼び出し、イテレーションを開始します。
28    foreach ($stack as $item) {
29        echo "Processing: " . $item . "\n";
30    }
31
32    echo "\n--- 明示的に rewind() を呼び出した後の2回目のイテレーション ---\n";
33    // SplStack::rewind は引数なし、戻り値なしです。
34    // 明示的に rewind() を呼び出すことで、イテレータを先頭に戻します。
35    $stack->rewind();
36
37    // 再度 foreach ループでスタックの要素を処理します。
38    // rewind() の効果により、最初のイテレーションと同じ順序で処理が開始されます。
39    foreach ($stack as $item) {
40        echo "Processing Again: " . $item . "\n";
41    }
42
43    echo "\n--- 3回目のイテレーション (改めて rewind() を呼び出す必要はありません) ---\n";
44    // foreach ループは毎回開始時に rewind() を自動で呼び出すため、
45    // 常にスタックの先頭からイテレーションが開始されます。
46    foreach ($stack as $item) {
47        echo "Processing Third Time: " . $item . "\n";
48    }
49}
50
51// 関数を実行して、SplStack::rewind の動作を確認します。
52demonstrateSplStackRewind();

PHPのSplStackクラスは、LIFO（Last-In, First-Out）形式でデータを管理するスタック構造を提供します。このクラスはIteratorインターフェースを実装しているため、foreachループを使ってスタック内の要素を順番に処理することができます。

SplStack::rewindメソッドは、イテレータ（スタック内の要素を順に辿るための内部的なポインタ）を最初の要素の位置に戻す役割を持っています。これにより、一度要素の最後まで処理が進んだ後でも、スタックの先頭から再度イテレーションを開始できるようになります。

通常、foreachループは開始時に自動的にrewind()メソッドを呼び出すため、毎回スタックの最初から要素が処理されます。しかし、イテレータを直接操作する場合や、途中で処理を中断し、後から同じスタックを再度先頭から処理したい場合には、このrewind()メソッドを明示的に呼び出すことが有効です。

rewind()メソッドは引数を一切取りません。また、呼び出しても特に値を返しません。サンプルコードでは、一度スタックを最後まで処理した後にrewind()を明示的に呼び出すことで、再びスタックの先頭から要素を反復処理できることを示しています。これにより、同じSplStackインスタンスを複数回にわたって利用できるため、柔軟なデータ処理が可能となります。

Copy
1<?php
2
3/**
4 * SplStackクラスとrewindメソッドの使用例を示します。
5 *
6 * SplStackは、LIFO (Last-In, First-Out) の原則に基づいたスタックデータ構造です。
7 * データはスタックの末尾にのみ追加（push）され、末尾からのみ削除（pop）されます。
8 *
9 * SplStackはIteratorインターフェースを実装しており、foreachループで要素を順に処理できます。
10 * イテレータとして使う場合、要素はpushされた順序（つまり、スタックの底から順に）取得されます。
11 *
12 * rewindメソッドは、イテレータの内部ポインタを最初の要素（スタックの底）にリセットする役割があります。
13 * これにより、イテレーションを最初からやり直すことができます。
14 */
15function demonstrateSplStackRewind(): void
16{
17    // SplStackインスタンスを作成
18    $stack = new SplStack();
19
20    // スタックに要素を複数追加（push）
21    echo "--- スタックに要素を追加 ---\n";
22    $stack->push('要素 A'); // 最初にpushされた要素（スタックの底）
23    $stack->push('要素 B');
24    $stack->push('要素 C'); // 最後にpushされた要素（スタックのトップ）
25    echo "スタックに3つの要素が追加されました。\n\n";
26
27    // 最初のイテレーション：foreachループでスタックの要素を処理
28    // foreachは、イテレーションを開始する前に自動的にrewind()を呼び出し、ポインタをリセットします。
29    // そのため、要素はpushされた順序（A -> B -> C）で取得されます。
30    echo "--- 最初のイテレーション（foreachが自動的にrewind()を呼び出します）---\n";
31    foreach ($stack as $item) {
32        echo "取得要素: " . $item . "\n";
33    }
34    echo "最初のイテレーションが終了しました。イテレータポインタは終端にあります。\n\n";
35
36    // rewind()メソッドを明示的に呼び出して、イテレータのポインタをリセット
37    // これをしないと、既に終端に達しているイテレータは次のイテレーションで要素を返しません。
38    echo "--- rewind() を明示的に呼び出し ---\n";
39    $stack->rewind();
40    echo "rewind() が呼び出され、イテレータポインタが最初の要素（'要素 A'）にリセットされました。\n\n";
41
42    // 2回目のイテレーション：rewind()後、再びforeachループで要素を処理
43    // ポインタがリセットされたため、再び最初の要素からイテレーションが開始されます。
44    echo "--- 2回目のイテレーション ---\n";
45    foreach ($stack as $item) {
46        echo "取得要素: " . $item . "\n";
47    }
48    echo "2回目のイテレーションが終了しました。\n";
49}
50
51// 関数を実行してSplStackのrewindメソッドの動作を確認
52demonstrateSplStackRewind();

このコードはPHPのSplStackクラスと、そのrewindメソッドの動作を示しています。SplStackは、最後に入れたものが最初に出てくる（LIFO）という特性を持つ「スタック」というデータ構造を扱うクラスです。このクラスは、要素を順に処理するためのIteratorインターフェースを実装しているため、foreachループなどでその内容を繰り返し処理できます。

SplStackのrewindメソッドは、イテレータの内部ポインタを最初の要素（スタックの底）にリセットする役割があります。これにより、既に終端に達したイテレータを再び最初から処理し直すことが可能になります。このメソッドは引数を取らず、特に戻り値もありません。

サンプルコードでは、まずSplStackに複数の要素を追加しています。最初のforeachループでは、PHPがイテレーションを開始する際に自動的にrewindメソッドを呼び出すため、要素は最初に追加された順に取得されます。このループが終了すると、イテレータのポインタはデータの終端に位置します。もしここで再度foreachループを回しても、ポインタが終端にあるため、要素は取得されません。

そこで、明示的に$stack->rewind()を呼び出すことで、イテレータのポインタを再び最初の要素に巻き戻します。その後、2回目のforeachループを実行すると、ポインタがリセットされているため、再び最初の要素からイテレーションが開始され、すべての要素を順に取得できる様子が確認できます。このように、rewindメソッドはイテレーションを繰り返し行いたい場合に利用されます。

Copy
1<?php
2
3/**
4 * Demonstrates the use of SplStack::rewind() method.
5 *
6 * SplStack is a specialized data structure that operates as a Last-In, First-Out (LIFO) stack.
7 * It implements the Iterator interface, allowing it to be traversed using constructs like `foreach`.
8 *
9 * The rewind() method, inherited from the Iterator interface, resets the internal
10 * iterator pointer of the stack to its initial position. For SplStack, this means
11 * setting the pointer to the "top" of the stack (the element that was most recently pushed).
12 *
13 * This is particularly useful when you have iterated through the stack once and
14 * need to iterate through it again from the beginning without modifying the stack's contents
15 * (e.g., by popping elements).
16 */
17function demonstrateSplStackRewind(): void
18{
19    // 1. Create a new SplStack instance
20    $stack = new SplStack();
21
22    // 2. Push some elements onto the stack
23    // Elements are pushed from bottom to top: 'Apple' (bottom) -> 'Banana' -> 'Cherry' (top)
24    $stack->push('Apple');
25    $stack->push('Banana');
26    $stack->push('Cherry');
27
28    echo "--- First Iteration (LIFO Order: Top to Bottom) ---\n";
29    // 3. Iterate over the stack for the first time.
30    // SplStack iterates from the most recently added item ('Cherry') to the least ('Apple').
31    // After this loop completes, the internal iterator pointer will be at the end,
32    // meaning a subsequent iteration would find no elements unless reset.
33    foreach ($stack as $item) {
34        echo "Item during first iteration: " . $item . "\n";
35    }
36
37    echo "\n--- Calling SplStack::rewind() to reset the iterator ---\n";
38    // 4. Call rewind() to reset the internal iterator pointer.
39    // This moves the pointer back to the 'Cherry' element (the top of the stack),
40    // allowing the stack to be iterated from the beginning again.
41    $stack->rewind();
42
43    echo "\n--- Second Iteration (after rewind(), LIFO Order) ---\n";
44    // 5. Iterate over the stack again.
45    // Because rewind() was called, the iteration starts from the top ('Cherry') once more.
46    foreach ($stack as $item) {
47        echo "Item during second iteration: " . $item . "\n";
48    }
49
50    echo "\n--- Demonstrating direct pointer access with current() before and after rewind() ---\n";
51    $stack->rewind(); // Ensure the pointer is at the very top for a clear demonstration
52    echo "Current item immediately after rewind(): " . $stack->current() . " (Expected: Cherry)\n";
53
54    $stack->next(); // Move the pointer to the next element ('Banana')
55    echo "Current item after next(): " . $stack->current() . " (Expected: Banana)\n";
56
57    $stack->rewind(); // Reset the pointer again
58    echo "Current item after second rewind(): " . $stack->current() . " (Expected: Cherry)\n";
59}
60
61// Execute the demonstration function
62demonstrateSplStackRewind();

PHP 8のSplStackクラスは、データを「最後に入れたものが最初に出てくる（LIFO）」という方式で管理する特殊なスタック構造です。このクラスはIteratorインターフェースを実装しているため、foreachループでスタックの要素を順に処理できますが、一度処理し終えるとイテレータポインタは終端に移動してしまいます。

SplStack::rewind()メソッドは、この内部イテレータポインタを初期位置、つまりスタックの一番上（最新の要素）に戻す役割を持ちます。このメソッドは引数を一切受け取らず、戻り値もありません。

このメソッドを使うことで、スタックの内容を変更することなく、foreachループなどで既に一度走査したスタックを、もう一度最初から要素を処理できるようになります。例えば、サンプルコードではスタックを一度処理した後、rewind()を呼び出すことで、再度foreachループでスタックの先頭から要素を取り出すことが可能になる様子が示されています。これにより、同じスタックを繰り返し利用したい場合に非常に便利です。