【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構造を効率的に扱うための強力な手段を提供します。