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

Copy
1<?php
2
3/**
4 * XMLReader を使用してXMLを読み込み、特定の名前空間を持つ属性の値を表示します。
5 *
6 * @param string $xmlString 読み込むXML文字列。
7 * @param string $elementName 属性を検索する要素の名前。
8 * @param string $attributeLocalName 取得したい属性のローカル名。
9 * @param string $attributeNamespace 取得したい属性の名前空間URI。
10 * @return void
11 */
12function findAttributeNsInXml(
13    string $xmlString,
14    string $elementName,
15    string $attributeLocalName,
16    string $attributeNamespace
17): void {
18    $reader = new XMLReader();
19
20    // XML文字列を読み込みソースとして設定します。
21    if (!$reader->XML($xmlString)) {
22        echo "エラー: XMLの読み込みに失敗しました。\n";
23        return;
24    }
25
26    echo "XMLを読み込み中... 要素 '{$elementName}' の属性 '{$attributeLocalName}' (名前空間: '{$attributeNamespace}') を検索します。\n";
27
28    // XMLノードを順に読み進めます。
29    while ($reader->read()) {
30        // 現在のノードが要素であり、かつ指定された要素名であるかを確認します。
31        if ($reader->nodeType === XMLReader::ELEMENT && $reader->name === $elementName) {
32            // getAttributeNs メソッドを使用して、指定された名前空間URIとローカル名を持つ属性を取得します。
33            $attributeValue = $reader->getAttributeNs($attributeLocalName, $attributeNamespace);
34
35            if ($attributeValue !== false) {
36                // 属性が見つかった場合、その値を表示します。
37                echo "  要素 '{$elementName}' にて、属性 '{$attributeLocalName}' (名前空間: '{$attributeNamespace}') の値: '{$attributeValue}' が見つかりました。\n";
38            } else {
39                // 属性が見つからなかった場合、その旨を表示します。
40                echo "  要素 '{$elementName}' には、属性 '{$attributeLocalName}' (名前空間: '{$attributeNamespace}') は見つかりませんでした。\n";
41            }
42        }
43    }
44
45    // リーダーを閉じ、リソースを解放します。
46    $reader->close();
47    echo "XMLの読み込みを完了しました。\n";
48}
49
50// サンプルXMLデータ
51// 'prod' というプレフィックスで名前空間 "http://example.com/products" を定義しています。
52$sampleXml = <<<XML
53<root xmlns:prod="http://example.com/products">
54    <item prod:id="P001" name="Laptop" price="1200">
55        <description>High performance laptop.</description>
56    </item>
57    <item id="P002" name="Mouse" price="25">
58        <description>Wireless ergonomic mouse.</description>
59    </item>
60    <item prod:id="P003" prod:category="Electronics" name="Keyboard">
61        <description>Mechanical keyboard.</description>
62    </item>
63</root>
64XML;
65
66// サンプルコードの実行例
67
68// 例1: prod名前空間の'id'属性を'item'要素から検索します。
69echo "--- 検索1: 'prod:id' 属性を検索 ---\n";
70findAttributeNsInXml($sampleXml, 'item', 'id', 'http://example.com/products');
71
72echo "\n"; // 区切り
73
74// 例2: prod名前空間の'category'属性を'item'要素から検索します。
75echo "--- 検索2: 'prod:category' 属性を検索 ---\n";
76findAttributeNsInXml($sampleXml, 'item', 'category', 'http://example.com/products');
77
78echo "\n"; // 区切り
79
80// 例3: 存在しない属性 (prod名前空間の'version') を検索します。
81echo "--- 検索3: 存在しない属性 'prod:version' を検索 ---\n";
82findAttributeNsInXml($sampleXml, 'item', 'version', 'http://example.com/products');
83
84echo "\n"; // 区切り
85
86// 例4: 名前空間を持たない属性 ('id') を getAttributeNs で検索します。
87// getAttributeNs の第二引数に空文字列を指定すると、名前空間を持たない属性を検索します。
88// 通常、名前空間を持たない属性は getAttribute() メソッドで取得しますが、
89// getAttributeNs() の挙動の理解のためにこの例を含みます。
90echo "--- 検索4: 名前空間を持たない 'id' 属性を getAttributeNs で検索 ---\n";
91findAttributeNsInXml($sampleXml, 'item', 'id', '');
92
93?>

XMLReader::getAttributeNsは、PHP 8で提供されるXMLReader拡張機能の一部で、XMLデータを効率的に読み込む際に使用されます。このメソッドは、XMLドキュメント内の要素に付与された属性のうち、特定の名前空間に属する属性の値を正確に取得するために設計されています。

第一引数$localNameには、属性のプレフィックス（例: prod:idのprod部分）を含まないローカル名（この場合はid）を指定します。第二引数$namespaceには、その属性が属する名前空間のURI（Uniform Resource Identifier）を正確に指定する必要があります。これはプレフィックス自体ではなく、XML内で定義されている完全なURIです。

メソッドが指定された属性を見つけ出した場合、その属性の値が文字列として返されます。もし属性が見つからなかった場合、戻り値はfalseとなりますので、プログラムでこのfalseを適切に処理することが重要です。

サンプルコードでは、XMLReaderオブジェクトがXML文字列を読み込み、read()メソッドでXMLノードを一つずつ処理しています。特定の要素に到達した際、getAttributeNs()メソッドを用いて、例えば「http://example.com/products」という名前空間に属する「id」というローカル名の属性を検索し、その値を取得・表示しています。名前空間を持たない属性を検索する際には、第二引数に空文字列を指定することでも利用できますが、通常はそのような場合はgetAttribute()メソッドを使用します。このメソッドを使うことで、名前空間が適切に管理された複雑なXMLデータから必要な情報を簡潔に抽出できます。

Copy
1<?php
2
3/**
4 * XMLファイルから特定の要素の属性値を名前空間を指定して取得する関数。
5 * XMLReader::getAttributeNs メソッドの使用例を示します。
6 * システムエンジニアを目指す初心者にも分かりやすいように、
7 * XMLの読み込み、要素の検索、名前空間付き属性の取得の手順を簡潔にまとめています。
8 *
9 * @param string $xmlFilePath 処理するXMLファイルのパス
10 * @param string $elementLocalName 属性を取得する要素のローカル名
11 * @param string $attributeLocalName 取得する属性のローカル名
12 * @param string $attributeNamespace 取得する属性の名前空間URI
13 * @return string|false 属性値、または属性が見つからない場合は false
14 */
15function getXmlAttributeNs(
16    string $xmlFilePath,
17    string $elementLocalName,
18    string $attributeLocalName,
19    string $attributeNamespace
20): string|false {
21    // XMLReader オブジェクトを初期化
22    $reader = new XMLReader();
23
24    // XMLファイルを開く試行
25    if (!$reader->open($xmlFilePath)) {
26        // ファイルが開けない場合はエラーメッセージを出力し、falseを返す
27        error_log("Error: Could not open XML file: {$xmlFilePath}");
28        return false;
29    }
30
31    // XMLノードを順に読み込むループ
32    while ($reader->read()) {
33        // 現在のノードが要素であり、かつ指定されたローカル名と一致する場合
34        if ($reader->nodeType === XMLReader::ELEMENT && $reader->localName === $elementLocalName) {
35            // 現在の要素から、指定されたローカル名と名前空間URIを持つ属性の値を取得
36            $attributeValue = $reader->getAttributeNs($attributeLocalName, $attributeNamespace);
37
38            // リーダーを閉じてリソースを解放
39            $reader->close();
40            // 取得した属性値を返す
41            return $attributeValue;
42        }
43    }
44
45    // ループ終了までに指定された要素や属性が見つからなかった場合
46    $reader->close();
47    return false;
48}
49
50// ------------------------------------------------------------------------------------------------
51// サンプルコードの実行部分
52// ------------------------------------------------------------------------------------------------
53
54// サンプルXMLコンテンツを定義
55$xmlContent = <<<XML
56<root xmlns:app="http://example.com/application/ns">
57    <item id="1" name="Item One" app:status="active">
58        Description for item one.
59    </item>
60    <item id="2" name="Item Two">
61        Description for item two.
62    </item>
63    <product id="p1" app:type="digital">
64        Digital Product
65    </product>
66</root>
67XML;
68
69// 一時ファイルにXMLコンテンツを書き込む
70$tempXmlFile = tempnam(sys_get_temp_dir(), 'xml_example');
71if ($tempXmlFile === false) {
72    die("Failed to create temporary file.\n");
73}
74file_put_contents($tempXmlFile, $xmlContent);
75
76echo "--- XMLReader::getAttributeNs 使用例 ---\n\n";
77
78// 例1: 存在する名前空間付き属性を取得
79echo "Example 1: Getting 'app:status' from 'item' element.\n";
80$value1 = getXmlAttributeNs($tempXmlFile, 'item', 'status', 'http://example.com/application/ns');
81if ($value1 !== false) {
82    echo "  Attribute value: '{$value1}' (Expected: 'active')\n";
83} else {
84    echo "  Attribute not found.\n";
85}
86echo "\n";
87
88// 例2: 存在する別の名前空間付き属性を取得
89echo "Example 2: Getting 'app:type' from 'product' element.\n";
90$value2 = getXmlAttributeNs($tempXmlFile, 'product', 'type', 'http://example.com/application/ns');
91if ($value2 !== false) {
92    echo "  Attribute value: '{$value2}' (Expected: 'digital')\n";
93} else {
94    echo "  Attribute not found.\n";
95}
96echo "\n";
97
98// 例3: 存在しない属性名で検索
99echo "Example 3: Getting 'app:missing' from 'item' element (should not exist).\n";
100$value3 = getXmlAttributeNs($tempXmlFile, 'item', 'missing', 'http://example.com/application/ns');
101if ($value3 !== false) {
102    echo "  Attribute value: '{$value3}' (Unexpectedly found)\n";
103} else {
104    echo "  Attribute not found (Expected: not found).\n";
105}
106echo "\n";
107
108// 例4: 存在しない名前空間URIで検索
109echo "Example 4: Getting 'status' from 'item' element with wrong namespace.\n";
110$value4 = getXmlAttributeNs($tempXmlFile, 'item', 'status', 'http://example.com/wrong/ns');
111if ($value4 !== false) {
112    echo "  Attribute value: '{$value4}' (Unexpectedly found)\n";
113} else {
114    echo "  Attribute not found (Expected: not found).\n";
115}
116echo "\n";
117
118// 一時ファイルを削除してクリーンアップ
119unlink($tempXmlFile);
120
121?>

XMLReader::getAttributeNsメソッドは、PHPでXMLファイルを効率的に読み込む際に、特定の名前空間に属する属性の値を取得するために使用されます。このメソッドはXMLReaderクラスの一部であり、ストリームベースでXMLを処理するため、大規模なXMLファイルでもメモリ効率良く扱えます。

引数には、取得したい属性のローカル名（$localName）と、その属性が属する名前空間のURI（$namespace）を指定します。例えば、<item app:status="active">のような要素からapp:status属性のactiveという値を取得したい場合、statusをローカル名、appプレフィックスが指すURIを名前空間として渡します。

メソッドは、現在のXML要素ノードから、指定されたローカル名と名前空間URIに完全に一致する属性を検索します。属性が見つかった場合はその値（文字列）を返し、見つからなかった場合はfalseを返します。

提供されたサンプルコードでは、getXmlAttributeNs関数を通じて、XMLファイルをオープンし、while ($reader->read())ループでXMLノードを一つずつ読み進めます。指定された要素（例としてitemやproduct）に到達した際に、$reader->getAttributeNsを呼び出して名前空間付き属性の値を安全に取得する手順が示されています。属性値の取得後は、$reader->close()で必ずXMLリーダーのリソースを解放することが重要です。存在しない属性や名前空間を指定した場合にfalseが返される挙動も、実行例で確認することができます。