【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インスタンスを複数回にわたって利用できるため、柔軟なデータ処理が可能となります。