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

Copy
1<?php
2
3/**
4 * Demonstrates the SimpleXMLIterator::rewind() method in PHP 8.
5 *
6 * This example illustrates how to reset a SimpleXMLIterator object to the beginning
7 * of its iteration sequence. This allows the same XML data to be iterated over
8 * multiple times from the start.
9 *
10 * SimpleXMLIterator implements the PHP Iterator interface, making it inherently
11 * "rewindable". This capability is a key difference when compared to standard
12 * PHP generator functions (created using `yield`), which are typically
13 * "one-shot" and not rewindable after their first full consumption without
14 * re-executing the generator function itself.
15 */
16function demonstrateSimpleXMLIteratorRewind(): void
17{
18    // Sample XML data representing a list of books
19    $xmlString = <<<XML
20<?xml version="1.0" encoding="UTF-8"?>
21<books>
22    <book id="1">
23        <title>The Hitchhiker's Guide to the Galaxy</title>
24        <author>Douglas Adams</author>
25    </book>
26    <book id="2">
27        <title>Pride and Prejudice</title>
28        <author>Jane Austen</author>
29    </book>
30    <book id="3">
31        <title>1984</title>
32        <author>George Orwell</author>
33    </book>
34</books>
35XML;
36
37    // Create a SimpleXMLIterator instance from the XML string.
38    // The iterator will initially point to the <books> root element.
39    $xmlIterator = new SimpleXMLIterator($xmlString);
40
41    echo "--- First Iteration over Books ---" . PHP_EOL;
42    // Iterate over the <book> elements directly under the <books> root.
43    // SimpleXMLIterator provides object-like access to child elements.
44    foreach ($xmlIterator->book as $book) {
45        echo "Book ID: " . $book['id'] . PHP_EOL; // Access attribute 'id'
46        echo "Title: " . $book->title . PHP_EOL; // Access child element 'title'
47        echo "Author: " . $book->author . PHP_EOL; // Access child element 'author'
48        echo "-----------------------" . PHP_EOL;
49    }
50
51    echo PHP_EOL . "--- Rewinding the iterator ---" . PHP_EOL;
52    // Call rewind() to reset the internal pointer of the iterator.
53    // After this, the iterator is positioned at the start again,
54    // ready for a new traversal from the beginning of the book list.
55    $xmlIterator->rewind();
56
57    echo PHP_EOL . "--- Second Iteration over Books (after rewind) ---" . PHP_EOL;
58    // Iterate again, demonstrating that rewind() successfully reset the position.
59    // The loop starts from the first book just like the initial iteration.
60    foreach ($xmlIterator->book as $book) {
61        echo "Book ID: " . $book['id'] . PHP_EOL;
62        echo "Title: " . $book->title . PHP_EOL;
63        echo "Author: " . $book->author . PHP_EOL;
64        echo "-----------------------" . PHP_EOL;
65    }
66}
67
68// Execute the demonstration function when the script runs.
69demonstrateSimpleXMLIteratorRewind();

SimpleXMLIterator::rewind()メソッドは、PHPでXMLデータを扱う際に使用するSimpleXMLIteratorオブジェクトの内部ポインタを、XML構造の先頭にリセットするための機能です。このメソッドを呼び出すことで、一度最後まで処理したXMLデータを、再び最初から繰り返しアクセスできるようになります。引数は必要なく、特定の戻り値もありません。

サンプルコードでは、まず書籍のリストを含むXMLデータを作成し、SimpleXMLIteratorのインスタンスを生成しています。最初のforeachループで、XML内の各書籍のID、タイトル、著者情報を順番に表示します。このループが終了すると、イテレータの内部ポインタはXMLデータの末尾に位置します。

そこで$xmlIterator->rewind();を呼び出すと、イテレータのポインタが再びXMLデータの先頭、つまり最初の書籍の位置に戻ります。その後の2回目のforeachループでは、1回目と同様に最初の書籍から順に情報が表示され、rewind()メソッドによってイテレータの状態が正常にリセットされたことが確認できます。

SimpleXMLIteratorはPHPのIteratorインターフェースを実装しているため、このように「リワインド可能（巻き戻し可能）」な特性を持っています。これは、一度要素を生成しきると再利用できないことが多いPHPの通常のジェネレータ（yieldキーワードで作成されるもの）とは異なり、同じデータセットを複数回、繰り返し処理したい場合に非常に便利な機能です。

Copy
1<?php
2
3/**
4 * SimpleXMLIterator::rewind() メソッドの動作をデモンストレーションします。
5 *
6 * この関数は、XMLデータを SimpleXMLIterator でイテレートし、
7 * rewind() メソッドを使ってイテレータの内部ポインタを先頭に戻す方法を示します。
8 * これは、PHPの配列で reset() 関数を使ってポインタを先頭に戻すのと概念的に似ています。
9 */
10function demonstrateSimpleXMLIteratorRewind(): void
11{
12    // サンプルXMLデータを用意します。
13    // このXMLは簡単な書籍のリストを表します。
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<books>
17    <book id="1">
18        <title>PHP入門</title>
19        <author>山田 太郎</author>
20    </book>
21    <book id="2">
22        <title>PHP実践</title>
23        <author>田中 花子</author>
24    </book>
25    <book id="3">
26        <title>PHP応用</title>
27        <author>鈴木 一郎</author>
28    </book>
29</books>
30XML;
31
32    try {
33        // SimpleXMLIterator オブジェクトを作成します。
34        // これにより、XMLデータをイテレータとして操作できるようになります。
35        $xmlIterator = new SimpleXMLIterator($xmlString);
36    } catch (Exception $e) {
37        echo "SimpleXMLIteratorの作成に失敗しました: " . $e->getMessage() . "\n";
38        return;
39    }
40
41    echo "--- 1回目のイテレーション（ループ）---\n";
42    // 最初のイテレーションでXML要素を順に処理します。
43    // このループが終わると、イテレータの内部ポインタは末尾に移動します。
44    foreach ($xmlIterator as $book) {
45        echo "書籍ID: " . $book['id'] . ", タイトル: " . $book->title . "\n";
46    }
47
48    echo "\n--- SimpleXMLIterator::rewind() を呼び出します ---\n";
49    // rewind() メソッドを呼び出すことで、イテレータの内部ポインタを最初の要素に戻します。
50    // これにより、もう一度最初から要素を処理できるようになります。
51    $xmlIterator->rewind();
52    echo "イテレータのポインタが先頭に戻りました。\n";
53
54    echo "\n--- 2回目のイテレーション（ループ）---\n";
55    // rewind() の後、再度イテレーションを開始すると、最初から要素を処理できることを確認します。
56    foreach ($xmlIterator as $book) {
57        echo "書籍ID: " . $book['id'] . ", タイトル: " . $book->title . "\n";
58    }
59
60    echo "\nSimpleXMLIterator::rewind() のデモンストレーションが完了しました。\n";
61}
62
63// 関数を実行してデモンストレーションを開始します。
64demonstrateSimpleXMLIteratorRewind();

SimpleXMLIterator::rewind()は、PHP 8で提供されるSimpleXMLIteratorクラスのメソッドです。このメソッドは、XMLデータを反復処理（ループ）する際に使用されるイテレータの内部ポインタを、最初の要素の位置に戻す役割を果たします。引数はなく、戻り値もありません。

SimpleXMLIteratorは、XMLデータをまるで配列のように扱うためのクラスで、foreachループなどで要素を順に処理できます。一度foreachループが完了すると、イテレータの内部ポインタはデータの末尾に移動した状態になります。この状態で再度ループを試みても、何も処理されません。

ここでrewind()メソッドを呼び出すと、内部ポインタが再びXMLデータの最初の要素に戻ります。これにより、同じSimpleXMLIteratorオブジェクトを使って、XMLデータを最初からもう一度反復処理することが可能になります。これは、PHPの配列でreset()関数を使用して配列の内部ポインタを先頭に戻すのと概念的に同じです。

提供されたサンプルコードでは、まずXMLデータをSimpleXMLIteratorで読み込み、一度目のループで全ての書籍情報を表示しています。その後rewind()を呼び出すことでイテレータのポインタを先頭に戻し、二度目のループで再び最初から書籍情報を表示できることを示しています。このように、複数の処理で同じXMLデータを最初から参照したい場合に非常に有用なメソッドです。