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

Copy
1<?php
2
3/**
4 * SplObjectStorage の rewind メソッドの動作を示すサンプル関数です。
5 *
6 * SplObjectStorage は、オブジェクトをキーとして格納する特殊なコレクションです。
7 * Iterator インターフェースを実装しているため、foreach ループなどでイテレーション可能です。
8 * rewind メソッドを呼び出すことで、イテレータの内部ポインタをコレクションの最初の要素に巻き戻し、
9 * イテレーションを最初からやり直せるようにします。
10 * この性質は、データソースが「巻き戻し可能（rewindable）」であることを示します。
11 */
12function demonstrateSplObjectStorageRewind(): void
13{
14    echo "--- SplObjectStorage::rewind のデモンストレーション ---\n\n";
15
16    // 1. SplObjectStorage インスタンスを作成します。
17    $storage = new SplObjectStorage();
18
19    // 2. テスト用の匿名クラス（stdClass）のオブジェクトを作成します。
20    $obj1 = new stdClass();
21    $obj1->name = 'オブジェクトA';
22    $obj2 = new stdClass();
23    $obj2->name = 'オブジェクトB';
24    $obj3 = new stdClass();
25    $obj3->name = 'オブジェクトC';
26
27    // 3. オブジェクトを SplObjectStorage に追加します。
28    $storage->attach($obj1);
29    $storage->attach($obj2);
30    $storage->attach($obj3);
31
32    echo "--- 1回目のイテレーション（ループ） ---\n";
33    // 4. SplObjectStorage を foreach でイテレーション（順に処理）します。
34    foreach ($storage as $object) {
35        echo "イテレート中: " . $object->name . "\n";
36    }
37    echo "1回目のイテレーションが終了しました。\n\n";
38
39    // 5. rewind メソッドを呼び出してイテレータのポインタを先頭に戻します。
40    echo "SplObjectStorage::rewind() を呼び出し中... (イテレータを先頭に戻します)\n\n";
41    $storage->rewind(); // ここでイテレータのポインタが最初の要素に戻ります
42
43    echo "--- 2回目のイテレーション（ループ） ---\n";
44    // 6. 再度 SplObjectStorage をイテレーションします。
45    // rewind を呼び出したため、1回目と同じく最初の要素から処理が開始されます。
46    foreach ($storage as $object) {
47        echo "イテレート中: " . $object->name . "\n";
48    }
49    echo "2回目のイテレーションが終了しました。\n\n";
50
51    echo "SplObjectStorage は、rewind() メソッドを使用することで、\n";
52    echo "イテレーションをいつでも最初からやり直せる「巻き戻し可能」なコレクションです。\n";
53}
54
55// 関数を実行し、SplObjectStorage::rewind の動作を確認します。
56demonstrateSplObjectStorageRewind();
57

PHPのSplObjectStorage::rewindメソッドは、SplObjectStorageクラスが提供する機能の一つです。SplObjectStorageは、オブジェクトをキーとしてデータを管理する特別なコレクションであり、foreachループなどを使ってその中の要素を順に処理する「イテレーション」が可能です。

このrewindメソッドは引数を取らず、戻り値もありませんが、SplObjectStorageが持つイテレータの内部ポインタを、コレクションの最初の要素に巻き戻す役割を果たします。一度foreachループなどで全ての要素を処理し終えると、イテレータのポインタは終端に達します。しかし、rewindメソッドを呼び出すことで、このポインタを再び先頭に戻し、コレクションを最初からもう一度イテレーションできるようになります。

これにより、SplObjectStorageは「巻き戻し可能（rewindable）」なコレクションとして振る舞います。サンプルコードでは、一度オブジェクトを順に表示した後、rewind()を呼び出すことで、再び最初のオブジェクトから処理を再開できる様子が示されています。この機能は、同じデータを複数回にわたって繰り返し処理したい場合に非常に役立ちます。

Copy
1<?php
2
3/**
4 * SplObjectStorage::rewind() メソッドの使用例。
5 *
6 * SplObjectStorage は、オブジェクトをキーとして任意のデータを格納できる特殊なコレクションクラスです。
7 * rewind() メソッドは、内部のイテレータ（走査する位置を示すポインタ）をコレクションの先頭に戻します。
8 * これにより、一度 foreach ループなどで最後まで処理したコレクションを、再度最初から走査できるようになります。
9 */
10
11// 1. SplObjectStorage のインスタンスを作成
12$storage = new SplObjectStorage();
13
14// 2. いくつかのオブジェクトを作成し、ストレージにアタッチ（追加）します。
15// stdClass は、プロパティを動的に追加できるシンプルな汎用オブジェクトです。
16$obj1 = new stdClass();
17$obj1->id = 1;
18$obj1->name = 'データA';
19$storage->attach($obj1);
20
21$obj2 = new stdClass();
22$obj2->id = 2;
23$obj2->name = 'データB';
24$storage->attach($obj2);
25
26$obj3 = new stdClass();
27$obj3->id = 3;
28$obj3->name = 'データC';
29$storage->attach($obj3);
30
31echo "--- 最初のイテレーション ---" . PHP_EOL;
32echo "コレクションの内容を一度走査します。イテレータは末尾に進みます。" . PHP_EOL;
33
34// 3. foreach ループでコレクションの内容を走査します。
35// このループが終了すると、イテレータはコレクションの末尾に位置します。
36foreach ($storage as $object) {
37    echo "処理中: オブジェクトID " . $object->id . ", 名前 " . $object->name . PHP_EOL;
38}
39
40echo PHP_EOL . "--- rewind() メソッドの呼び出し ---" . PHP_EOL;
41// 4. rewind() メソッドを呼び出して、イテレータをコレクションの先頭に戻します。
42$storage->rewind();
43echo "SplObjectStorage::rewind() を呼び出しました。イテレータが先頭に戻されました。" . PHP_EOL;
44
45echo PHP_EOL . "--- 2回目のイテレーション ---" . PHP_EOL;
46echo "rewind() のおかげで、コレクションを再度最初から走査できます。" . PHP_EOL;
47
48// 5. 再び foreach ループでコレクションの内容を走査します。
49// rewind() が呼び出されていない場合、このループは何も出力しません。
50foreach ($storage as $object) {
51    echo "再処理中: オブジェクトID " . $object->id . ", 名前 " . $object->name . PHP_EOL;
52}
53
54?>

PHPのSplObjectStorage::rewind()メソッドは、オブジェクトをキーとしてデータを格納できる特殊なコレクションクラスであるSplObjectStorageの内部イテレータ（走査する位置を示すポインタ）を、コレクションの先頭に戻すために使用されます。

SplObjectStorageは、foreachループなどを使用して内容を走査できます。一度foreachループでコレクションの最後まで処理を終えると、内部のイテレータはコレクションの末尾に移動します。この状態では、再度コレクションを最初から走査しようとしても、既に末尾にいるため、何も処理が行われません。

rewind()メソッドを呼び出すことで、この末尾にあるイテレータを強制的にコレクションの最初の位置に戻すことができます。これにより、既に一度走査を終えたSplObjectStorageのインスタンスを、再度最初から繰り返し処理できるようになります。

このメソッドは引数を一切取らず、また特定の値を戻り値として返しません。単にSplObjectStorageオブジェクトの内部状態（イテレータの位置）を先頭にリセットする役割を果たします。サンプルコードでは、最初のforeachループ後にrewind()を呼び出すことで、二度目のforeachループでもコレクションの内容が正しく出力される様子を確認できます。