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

Copy
1<?php
2
3/**
4 * XMLReader::expand メソッドの使用例
5 * 指定されたXMLファイルから'item'ノードを見つけ、XMLReaderの現在位置にあるノードを
6 * DOMNodeオブジェクトとして展開し、その内容を処理します。
7 *
8 * XMLReader::expandは、XMLReaderが現在読み込んでいるノードとその子孫ノードを
9 * DOMNodeとして「展開」し、DOM（Document Object Model）APIを使って操作できるようにします。
10 *
11 * @param string $xmlFilePath 処理するXMLファイルのパス
12 * @return void
13 */
14function processXmlItemsWithExpand(string $xmlFilePath): void
15{
16    // XMLReader インスタンスを作成
17    $reader = new XMLReader();
18
19    // 指定されたXMLファイルをオープン
20    if (!$reader->open($xmlFilePath)) {
21        echo "エラー: XMLファイルをオープンできませんでした: {$xmlFilePath}\n";
22        return;
23    }
24
25    echo "XMLファイルの処理を開始します: {$xmlFilePath}\n";
26
27    // XMLドキュメントを順に読み進める
28    while ($reader->read()) {
29        // 現在のノードが要素（Element）であり、かつその名前が'item'であるかチェック
30        if ($reader->nodeType === XMLReader::ELEMENT && $reader->name === 'item') {
31            echo "\n'item' ノードを見つけました。\n";
32
33            // XMLReaderの現在位置にある'item'ノードをDOMNodeとして展開します。
34            // expand() メソッドは、現在のノードとそのすべての子ノードを含むDOMNodeオブジェクトを返します。
35            $domNode = $reader->expand();
36
37            // 戻り値がDOMNodeのインスタンスであることを確認
38            if ($domNode instanceof DOMNode) {
39                // DOMNodeを使って属性や子要素の値にアクセス
40                echo "  ID: " . $domNode->getAttribute('id') . "\n";
41
42                // 'name'タグの子要素を取得し、その値を出力
43                $nameNode = $domNode->getElementsByTagName('name')->item(0);
44                if ($nameNode && $nameNode->nodeValue) {
45                    echo "  名前: " . $nameNode->nodeValue . "\n";
46                }
47
48                // 'price'タグの子要素を取得し、その値を出力
49                $priceNode = $domNode->getElementsByTagName('price')->item(0);
50                if ($priceNode && $priceNode->nodeValue) {
51                    echo "  価格: " . $priceNode->nodeValue . "\n";
52                }
53            } else {
54                echo "エラー: expand() がDOMNodeを返しませんでした。\n";
55            }
56        }
57    }
58
59    // XMLReader をクローズし、リソースを解放
60    $reader->close();
61    echo "\nXMLファイルの処理が完了しました。\n";
62}
63
64// === 実行例 ===
65// テスト用のXMLファイルを動的に作成します。
66$xmlContent = <<<XML
67<?xml version="1.0" encoding="UTF-8"?>
68<root>
69    <header>
70        <title>製品リスト</title>
71        <date>2023-10-27</date>
72    </header>
73    <item id="P001">
74        <name>ノートPC</name>
75        <price>120000</price>
76        <description>高性能ノートパソコン</description>
77    </item>
78    <item id="P002">
79        <name>スマートフォン</name>
80        <price>85000</price>
81        <description>最新モデルのスマートフォン</description>
82    </item>
83    <footer/>
84</root>
85XML;
86
87$testXmlFile = 'products_data.xml';
88file_put_contents($testXmlFile, $xmlContent); // XML内容をファイルに書き込む
89
90// 作成したXMLファイルを使って関数を実行
91processXmlItemsWithExpand($testXmlFile);
92
93// テスト用ファイルをクリーンアップ（削除）します。
94if (file_exists($testXmlFile)) {
95    unlink($testXmlFile);
96    echo "\nテスト用XMLファイル '{$testXmlFile}' を削除しました。\n";
97}
98
99?>

XMLReader::expandは、PHP 8でXMLファイルを処理する際に使われるメソッドです。XMLReaderは、XMLデータをストリーム形式で順次読み込むことに特化しており、非常に大きなXMLファイルでもメモリを効率的に使って処理できる利点があります。しかし、特定のノードが見つかった後、そのノードの複雑な子要素や属性を詳細に操作するのには向いていません。

このexpandメソッドは、XMLReaderが現在位置しているノードを、DOM（Document Object Model）という別の形式のオブジェクト（DOMNode）として「展開」する役割を担います。これにより、ストリーム処理の効率性とDOM APIの柔軟な操作性を両立させることが可能になります。

サンプルコードでは、XMLReaderでXMLファイルを読み進め、<item>という特定の要素を見つけます。<item>ノードに到達した際に$reader->expand()を呼び出すことで、現在の<item>ノードとそのすべての子ノードがDOMNodeオブジェクトとして取得されます。このDOMNodeオブジェクトを使えば、getAttribute()で属性値を取得したり、getElementsByTagName()で子要素を検索し、そのnodeValueで内容を直接取得したりと、より直感的かつ詳細なXML構造の操作ができるようになります。

引数?DOMNode $baseNode = nullはオプションで、通常は指定せずnullのまま使用します。これにより、現在のノードが独立したDOMNodeとして展開されます。メソッドの戻り値は、展開が成功すればDOMNodeオブジェクト、失敗した場合はfalseとなりますので、処理結果を適切に確認することが重要です。XMLReader::expandは、XMLのストリーム処理とDOM操作を組み合わせ、複雑なXML構造を効率的に扱うための強力な手段を提供します。

Copy
1<?php
2
3/**
4 * XMLReader::expand() メソッドの使用例を示します。
5 * このメソッドは、XMLReader が現在指しているノードを DOMNode オブジェクトとして展開し、
6 * そのノードと子孫を DOM の機能を使って操作できるようにします。
7 */
8function demonstrateXmlReaderExpand(): void
9{
10    $xmlString = <<<XML
11<root>
12    <item id="1">
13        <name>Product A</name>
14        <price>100</price>
15    </item>
16    <item id="2">
17        <name>Product B</name>
18        <price>200</price>
19    </item>
20</root>
21XML;
22
23    $reader = new XMLReader();
24    // XMLReader に XML 文字列をロードします。
25    if (!$reader->XML($xmlString)) {
26        echo "エラー: XML文字列のロードに失敗しました。\n";
27        return;
28    }
29
30    echo "--- XMLReader::expand() のデモンストレーションを開始します ---\n\n";
31
32    // XML を順に読み込み、特定のノードを探します。
33    while ($reader->read()) {
34        // <item> 要素に到達したことを確認します。
35        // XMLReader::ELEMENT はノードが要素型であることを示します。
36        if ($reader->nodeType === XMLReader::ELEMENT && $reader->name === 'item') {
37            echo "-> <item> 要素を検出しました (ノード名: " . $reader->name . ")\n";
38
39            // expand() メソッドを使って、現在の XMLReader ノードを DOMNode に変換します。
40            // これにより、DOM の機能を使ってノードとその子ノードを操作できるようになります。
41            // 戻り値は DOMNode オブジェクトか、失敗した場合は false です。
42            $domNode = $reader->expand();
43
44            if ($domNode instanceof DOMNode) {
45                echo "  - ノードは正常に DOMNode に展開されました。\n";
46                echo "  - 展開された DOMNode の名前: " . $domNode->nodeName . "\n";
47
48                // 展開された DOMNode から属性を取得する例
49                if ($domNode->hasAttributes()) {
50                    echo "  - 属性:\n";
51                    foreach ($domNode->attributes as $attr) {
52                        echo "    - " . $attr->name . ": " . $attr->value . "\n";
53                    }
54                }
55
56                // 展開された DOMNode から子要素を取得する例
57                echo "  - 子要素:\n";
58                foreach ($domNode->childNodes as $child) {
59                    // XML_ELEMENT_NODE はノードが要素型であることを示します。
60                    if ($child->nodeType === XML_ELEMENT_NODE) {
61                        echo "    - " . $child->nodeName . ": " . $child->nodeValue . "\n";
62                    }
63                }
64                echo "\n";
65
66                // 注意: expand() を呼び出すと、XMLReader は展開されたノードの子孫をスキップし、
67                // 次の兄弟ノードまたはその親の兄弟ノードへ自動的に進みます。
68                // この例では、最初の <item> ノードを処理したらデモンストレーションを終了します。
69                break;
70            } else {
71                echo "  - エラー: ノードの DOMNode への展開に失敗しました。\n\n";
72            }
73        }
74    }
75
76    $reader->close(); // XMLReader を閉じ、関連するリソースを解放します。
77    echo "--- デモンストレーションを終了します ---\n";
78}
79
80// 関数を実行します。
81demonstrateXmlReaderExpand();
82

PHPのXMLReader::expand()メソッドは、XMLファイルを効率的にストリーム形式で読み込むXMLReaderが現在指し示しているノードを、DOMNodeオブジェクトとして展開する際に使用します。これにより、現在処理中のノードとその子孫をメモリ上に構築し、DOM（Document Object Model）の持つ強力な機能を使って、ノードの属性や子要素へ簡単にアクセスしたり、詳細な操作を行ったりできるようになります。

このメソッドの引数?DOMNode $baseNode = nullはオプションで、通常は指定せずにnullのまま使用されます。メソッドは成功した場合にDOMNodeオブジェクトを返し、失敗した場合はfalseを返します。サンプルコードでは、XML内の<item>要素を検出した際にexpand()を呼び出し、その要素をDOMNodeに変換しています。変換後、DOMNodeの機能を使ってid属性の値や<name>、<price>といった子要素の内容にアクセスしている様子が示されています。

expand()を呼び出すと、XMLReaderは展開されたノードの子孫の読み込みを自動的にスキップし、次の兄弟ノードや親のノードへ進むため、XMLReaderのその後の読み込み位置に影響します。このメソッドは、XMLReaderの軽量なストリーム処理の利点を活かしつつ、特定のXML部分に対して一時的にDOMの柔軟な操作が必要となる場面で非常に有効です。

Copy
1<?php
2
3/**
4 * Demonstrates how to use XMLReader::expand to convert the current node
5 * into a DOMNode object.
6 *
7 * This function reads an XML string, finds the first 'item' element,
8 * and then 'expands' it into a DOMNode for further manipulation using DOM methods.
9 */
10function demonstrateXmlReaderExpand(): void
11{
12    // Define a sample XML string.
13    $xmlString = <<<XML
14<data>
15    <item id="1">
16        <name>Product A</name>
17        <price>10.00</price>
18    </item>
19    <item id="2">
20        <name>Product B</name>
21        <price>20.50</price>
22    </item>
23</data>
24XML;
25
26    $reader = new XMLReader();
27
28    // Open the XML string for reading.
29    if (!$reader->XML($xmlString)) {
30        echo "Error: Failed to open XML string.\n";
31        return;
32    }
33
34    echo "Reading XML and searching for an 'item' node...\n";
35
36    // Loop through the XML nodes until an 'item' element is found.
37    while ($reader->read()) {
38        // Check if the current node is an element and its name is 'item'.
39        if ($reader->nodeType === XMLReader::ELEMENT && $reader->name === 'item') {
40            echo "Found an 'item' element.\n";
41
42            // Use expand() to convert the current XMLReader node into a DOMNode object.
43            // When $baseNode is null (as here), XMLReader creates a new DOMDocument internally
44            // and imports the current node and its subtree into it.
45            $domNode = $reader->expand();
46
47            if ($domNode instanceof DOMNode) {
48                echo "Successfully expanded the 'item' node into a DOMNode.\n";
49
50                // Now you can work with the $domNode using standard DOM methods.
51                // For example, retrieve its tag name, attributes, or child elements.
52                echo "Expanded DOMNode Tag Name: " . $domNode->tagName . "\n";
53                echo "Expanded DOMNode Attributes:\n";
54                foreach ($domNode->attributes as $attribute) {
55                    echo "  - " . $attribute->name . ": " . $attribute->value . "\n";
56                }
57                
58                // Access a child element like 'name' within the expanded DOMNode.
59                $nameElement = $domNode->getElementsByTagName('name')->item(0);
60                if ($nameElement) {
61                    echo "Product Name (from expanded DOMNode): " . $nameElement->textContent . "\n";
62                }
63
64                // Output the XML representation of the expanded DOMNode.
65                echo "XML representation of the expanded DOMNode:\n";
66                echo $domNode->ownerDocument?->saveXML($domNode) . "\n";
67
68            } else {
69                echo "Error: Failed to expand the 'item' node.\n";
70            }
71
72            // We processed the first 'item', so we can stop reading.
73            break;
74        }
75    }
76
77    // Close the XMLReader to release resources.
78    $reader->close();
79    echo "XMLReader closed.\n";
80}
81
82// Execute the demonstration function.
83demonstrateXmlReaderExpand();
84
85?>

XMLReader::expandメソッドは、PHP 8で利用可能なXMLReader拡張機能の機能の一つです。XMLReaderは、XML文書を高速かつメモリ効率良く読み込むための前方参照型パーサーですが、特定のノードの内容を詳細に操作したい場合に、DOM（Document Object Model）ツリー構造に変換する機能を提供します。

このexpandメソッドを呼び出すと、XMLReaderが現在位置しているノードとその全ての子孫ノードが、DOMNodeオブジェクトとして返されます。これにより、XMLReaderの高速な読み込みと、DOMの持つ柔軟な操作性を組み合わせて利用することが可能になります。

引数$baseNodeは省略可能で、通常はnullを指定します。nullの場合、XMLReaderは内部で新しいDOMDocumentを作成し、そこに現在のノードをインポートします。これにより、返されたDOMNodeは完全に独立したDOMツリーの一部として扱えます。

戻り値は、変換が成功した場合はDOMNodeオブジェクト、失敗した場合はfalseです。成功すれば、返されたDOMNodeに対して、tagName、attributes、getElementsByTagNameなどのDOMメソッドを使って、その内容を詳細に解析したり変更したりできます。

提示されたサンプルコードでは、XML文字列をXMLReaderで読み込み、最初のitem要素が見つかった際にexpand()メソッドを呼び出しています。その結果得られたDOMNodeから、タグ名、属性、子要素のテキストコンテンツを取得し、最終的にそのDOMNodeのXML表現を出力することで、expandメソッドの挙動と利用方法を具体的に示しています。