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

Copy
1<?php
2
3/**
4 * XMLReader を使用してXML文字列から特定の要素の内部XMLを読み取るサンプル関数です。
5 * システムエンジニアを目指す初心者向けに、XMLReader の基本的な使い方と
6 * readInnerXml メソッドの動作を簡潔に示します。
7 */
8function readInnerXmlExample(): void
9{
10    // サンプルXMLデータ。実際にはファイルから読み込むことが多いです。
11    $xmlString = <<<XML
12    <books>
13        <book id="php001">
14            <title>PHP入門</title>
15            <author>山田 太郎</author>
16            <details>
17                <description>PHPの基本から応用までを解説しています。</description>
18                <pages>350</pages>
19                <publication_date>2023-01-15</publication_date>
20            </details>
21        </book>
22        <book id="xml001">
23            <title>XMLマスター</title>
24            <author>鈴木 花子</author>
25            <details>
26                <description>XML構造とパース方法について深く掘り下げます。</description>
27                <pages>420</pages>
28                <publication_date>2022-08-01</publication_date>
29            </details>
30        </book>
31    </books>
32    XML;
33
34    // XMLReader オブジェクトを新しく作成します。
35    $reader = new XMLReader();
36
37    // XML文字列を読み込みます。ファイルから読み込む場合は $reader->open('path/to/file.xml'); を使用します。
38    if (!$reader->xml($xmlString)) {
39        echo "エラー: XMLの読み込みに失敗しました。\n";
40        return;
41    }
42
43    echo "--- XML要素から内部XMLを読み取ります ---\n\n";
44
45    // XMLをノード単位で順に読み進めます。
46    while ($reader->read()) {
47        // 現在のノードが要素（開始タグ）であり、名前が 'details' の場合をチェックします。
48        if ($reader->nodeType === XMLReader::ELEMENT && $reader->name === 'details') {
49            echo "「details」要素を見つけました。\n";
50
51            // readInnerXml() メソッドは、現在の要素の開始タグと終了タグの間の
52            // すべてのXMLコンテンツを文字列として読み込みます。
53            // 例えば、<details>...</details> の場合、... の部分が返されます。
54            $innerXmlContent = $reader->readInnerXml();
55
56            echo "  取得した内部XML:\n";
57            echo "  " . str_replace("\n", "\n  ", $innerXmlContent) . "\n\n";
58
59            // 注意: readInnerXml() を呼び出すと、XMLReader は自動的に
60            // 現在の要素の終了タグの直前まで読み飛ばします。
61            // そのため、手動で内部要素を読み進める必要はありません。
62        }
63    }
64
65    // XMLReader のリソースを解放します。
66    $reader->close();
67    echo "XMLReaderを閉じました。\n";
68}
69
70// サンプル関数を実行します。
71readInnerXmlExample();

PHPのXMLReaderは、大きなXMLデータでもメモリを効率的に使用しながら読み進めるための機能です。その中でreadInnerXmlメソッドは、現在XMLReaderが指している要素の内部にあるXMLコンテンツ全体を、開始タグと終了タグを除いた状態で文字列として取得する際に利用します。このメソッドは引数を一切必要とせず、現在の要素の内部に含まれる全ての子要素やテキストノードをまとめたstring型のXML文字列を戻り値として返します。

サンプルコードでは、XMLReaderが<details>要素に到達した際にreadInnerXmlを呼び出しています。これにより、<details>から</details>の間に存在する<description>...</description>や<pages>...</pages>といった子要素を含むすべてのXML構造が、一つの文字列として取得されます。readInnerXmlが実行されると、XMLReaderは自動的に現在の要素の終了タグまで読み飛ばし、その内部の要素を個別に読み進める手間が省けます。この特性により、特定のXMLブロックの内容をまとめて処理したい場合に、コードをシンプルに記述できるのが大きな利点です。

Copy
1<?php
2
3/**
4 * XMLReader を使用して XML 文字列から特定の要素の内部 XML を読み取るサンプル関数。
5 *
6 * XMLReader は、大規模な XML ドキュメントを効率的に解析するためのプルパーサーです。
7 * readInnerXml() メソッドは、現在の要素ノードの子要素すべてを XML 文字列として読み込み、返します。
8 *
9 * @return void
10 */
11function demonstrateXmlReaderReadInnerXml(): void
12{
13    // サンプル XML データ
14    $xmlString = <<<XML
15<library>
16    <book id="1">
17        <title>The Art of XML</title>
18        <author>John Doe</author>
19        <pages>300</pages>
20        <details>
21            <publisher>Tech Books Inc.</publisher>
22            <year>2023</year>
23        </details>
24    </book>
25    <book id="2">
26        <title>PHP for Beginners</title>
27        <author>Jane Smith</author>
28        <pages>450</pages>
29        <details>
30            <publisher>Web Dev Publications</publisher>
31            <year>2022</year>
32        </details>
33    </book>
34</library>
35XML;
36
37    // XMLReader オブジェクトの作成
38    $reader = new XMLReader();
39
40    // XML 文字列をリーダーに読み込ませてオープン
41    if (!$reader->xml($xmlString)) {
42        echo "XML 文字列の読み込みに失敗しました。\n";
43        return;
44    }
45
46    echo "--- XMLReader::readInnerXml() のデモンストレーション ---\n\n";
47
48    // XML ドキュメントをノードごとに順に読み進める
49    while ($reader->read()) {
50        // 要素ノード (XML タグ) であるかを確認
51        if ($reader->nodeType === XMLReader::ELEMENT) {
52            // "book" という名前の要素が見つかった場合
53            if ($reader->name === 'book') {
54                echo "現在ノード: <book>\n";
55                // readInnerXml() を呼び出し、現在の要素 (book) の子要素すべてをXML文字列として取得
56                $innerXml = $reader->readInnerXml();
57                echo "readInnerXml() の結果:\n";
58                echo $innerXml . "\n\n";
59            }
60            // "details" という名前の要素が見つかった場合
61            // readInnerXml() を呼び出すと、そのノードの子孫をすべて読み飛ばすため、
62            // 次の read() はそのノードの次の兄弟ノードから開始されます。
63            elseif ($reader->name === 'details') {
64                echo "現在ノード: <details>\n";
65                // readInnerXml() を呼び出し、現在の要素 (details) の子要素すべてをXML文字列として取得
66                $innerXml = $reader->readInnerXml();
67                echo "readInnerXml() の結果:\n";
68                echo $innerXml . "\n\n";
69            }
70        }
71    }
72
73    // リーダーをクローズし、使用したリソースを解放
74    $reader->close();
75}
76
77// 上記の関数を実行
78demonstrateXmlReaderReadInnerXml();
79

PHPのXMLReaderは、大規模なXMLドキュメントを効率的に解析するための「プルパーサー」と呼ばれる機能を提供します。XMLReader::readInnerXml()メソッドは、このXMLReaderクラスに属し、現在XMLReaderが位置している要素ノード（XMLタグ）の内部にあるすべての子要素やテキストなどを、一つのXML文字列として読み込む役割を持っています。このメソッドは引数を必要とせず、読み込んだ内部XMLデータを文字列として返します。

readInnerXml()を呼び出すと、XMLReaderは現在の要素ノードの子孫ノードをすべて処理済みとしてスキップします。そのため、次にread()メソッドを呼び出した際には、現在の要素ノードの次の兄弟ノードから解析が再開されるという挙動を理解しておくことが重要です。

サンプルコードでは、XMLReaderを使ってXMLデータを読み込み、<book>や<details>といった特定の要素が見つかった際にreadInnerXml()を呼び出しています。これにより、例えば<book>要素の内部にある<title>から<details>まで、すべての子要素を含むXML断片が文字列として一度に取得され、表示されます。この機能は、特定のXMLブロックの内容をまとめて取得したい場合に非常に便利です。XMLReaderを利用するには、PHPのXML拡張機能が有効になっている必要があります。