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

Copy
1<?php
2
3/**
4 * DOMElement::getAttributeNodeNS メソッドの基本的な使用例を示します。
5 * このメソッドは、指定された名前空間URIとローカル名を持つ属性ノードをDOMAttrオブジェクトとして取得します。
6 * システムエンジニアを目指す初心者にも分かりやすいように、正確で簡潔なコードです。
7 */
8function main(): void
9{
10    // 名前空間 (xmlns:my="http://example.com/ns") を持つXML文字列を定義します。
11    // <item> 要素には 'my:id' という名前空間付き属性と、'value' という名前空間なし属性があります。
12    $xmlString = <<<XML
13<root xmlns:my="http://example.com/ns">
14    <item my:id="123" value="some_data"/>
15</root>
16XML;
17
18    // DOMDocument オブジェクトを作成します。
19    // XML文書を操作するための基本的なクラスです。
20    $dom = new DOMDocument();
21
22    // XML文字列をDOMDocumentにロードします。
23    // ロードに失敗した場合はエラーメッセージを出力し、処理を終了します。
24    if (!$dom->loadXML($xmlString)) {
25        echo "XMLのロードに失敗しました。\n";
26        return;
27    }
28
29    // ドキュメント内の全ての 'item' 要素を取得します。
30    // getElementsByTagName は、指定されたタグ名を持つ全ての要素のリスト (DOMNodeList) を返します。
31    $items = $dom->getElementsByTagName('item');
32
33    // 最初の 'item' 要素が存在するか確認します。
34    if ($items->length > 0) {
35        // DOMNodeList から最初の要素 (インデックス0) を取得します。
36        // この要素は DOMElement クラスのインスタンスであることが期待されます。
37        /** @var DOMElement $itemElement */
38        $itemElement = $items->item(0);
39
40        echo "--- 存在する名前空間付き属性の取得 ---\n";
41        // DOMElement::getAttributeNodeNS を使用して、名前空間付き属性ノードを取得します。
42        // 第1引数: 属性が所属する名前空間のURI ('http://example.com/ns')
43        // 第2引数: 属性のローカル名 ('id')
44        $attrNode = $itemElement->getAttributeNodeNS('http://example.com/ns', 'id');
45
46        // 属性ノードが正常に取得できたか確認します。
47        // 取得できた場合は DOMAttr オブジェクトが返されます。見つからない場合は null が返されます。
48        if ($attrNode instanceof DOMAttr) {
49            echo "指定された属性ノードが見つかりました。\n";
50            echo "  完全な属性名 (nodeName): {$attrNode->nodeName}\n";        // 例: my:id
51            echo "  ローカル名 (localName): {$attrNode->localName}\n";      // 例: id
52            echo "  名前空間URI (namespaceURI): {$attrNode->namespaceURI}\n"; // 例: http://example.com/ns
53            echo "  属性値 (value): {$attrNode->value}\n";                  // 例: 123
54        } else {
55            echo "エラー: 指定された名前空間とローカル名を持つ属性ノードが見つかりませんでした。\n";
56        }
57
58        echo "\n--- 存在しない名前空間付き属性の取得 ---\n";
59        // 存在しない名前空間付き属性 'nonexistent' を取得しようと試みます。
60        $nonExistentAttrNode = $itemElement->getAttributeNodeNS('http://example.com/ns', 'nonexistent');
61
62        // この場合、属性ノードは見つからないため、null が返されるはずです。
63        if ($nonExistentAttrNode instanceof DOMAttr) {
64            echo "エラー: 存在しないはずの属性ノードが見つかりました。\n";
65        } else {
66            echo "期待通り、存在しない属性 'nonexistent' は見つかりませんでした (null を返しました)。\n";
67        }
68
69    } else {
70        echo "XML内に '<item>' 要素が見つかりませんでした。\n";
71    }
72}
73
74// スクリプトの実行を開始します。
75main();
76

PHP 8のDOMElement::getAttributeNodeNSメソッドは、XML文書を操作する際に、特定の名前空間に属する属性ノードをDOMAttrオブジェクトとして取得するために利用されます。このメソッドは、XML要素が持つ複数の属性の中から、指定された名前空間URIとローカル名に一致する属性を正確に見つけ出す役割を果たします。

第一引数$namespaceには、取得したい属性が所属する名前空間のURIを文字列で渡します。nullを渡すことも可能ですが、このメソッドの主な目的は名前空間付き属性の取得です。第二引数$localNameには、属性の接頭辞を含まないローカル名（例えばmy:id属性であればid）を文字列で指定します。

メソッドが実行され、指定された名前空間URIとローカル名を持つ属性が要素内に存在した場合、その属性を表すDOMAttrオブジェクトが戻り値として返されます。このDOMAttrオブジェクトからは、属性の完全な名前、ローカル名、名前空間URI、そして属性値といった詳細な情報を取得できます。もし該当する属性が見つからなかった場合、このメソッドはnullを返します。

サンプルコードでは、<item my:id="123" .../>のような名前空間付き属性を持つXMLから、'http://example.com/ns'という名前空間URIと'id'というローカル名を指定してmy:id属性を取得しています。これにより、XML文書内の名前空間付き属性を確実かつ厳密に識別し、その情報を安全に取得できることが示されています。また、存在しない属性を検索した場合にnullが返される挙動も確認でき、属性の有無を適切に判断できるため、堅牢なプログラム作成に役立ちます。

Copy
1<?php
2
3// DOMDocument を作成し、XML をロードします。
4$dom = new DOMDocument();
5// XML文字列を定義。名前空間を持つ要素と属性を含めます。
6$xmlString = <<<XML
7<root xmlns:example="http://www.example.com/ns" xmlns:data="http://data.example.com/ns">
8  <item id="item1" example:type="primary" data:value="important-data">
9    これは名前空間付き属性を持つ要素です。
10  </item>
11  <item id="item2" status="active">
12    これは名前空間なし属性を持つ要素です。
13  </item>
14</root>
15XML;
16
17// XML文字列をDOMDocumentに読み込みます。
18$dom->loadXML($xmlString);
19
20// 'item' タグを持つ最初の DOMElement を取得します。（名前空間付き属性を含む）
21$elementWithNsAttr = $dom->getElementsByTagName('item')->item(0);
22
23// 'item' タグを持つ二番目の DOMElement を取得します。（名前空間なし属性を含む）
24$elementWithoutNsAttr = $dom->getElementsByTagName('item')->item(1);
25
26echo "--- 既存の名前空間付き属性 ('example:type') の取得 ---" . PHP_EOL;
27
28if ($elementWithNsAttr instanceof DOMElement) {
29    // 'example:type' 属性を名前空間URIとローカル名で取得します。
30    // 名前空間URI: "http://www.example.com/ns"
31    // ローカル名: "type"
32    $exampleTypeAttr = $elementWithNsAttr->getAttributeNodeNS('http://www.example.com/ns', 'type');
33
34    if ($exampleTypeAttr instanceof DOMAttr) {
35        echo "属性名 (完全修飾名): " . $exampleTypeAttr->name . PHP_EOL;
36        echo "属性値: " . $exampleTypeAttr->nodeValue . PHP_EOL;
37        echo "属性の名前空間URI: " . $exampleTypeAttr->namespaceURI . PHP_EOL;
38    } else {
39        echo "example:type 属性は見つかりませんでした。" . PHP_EOL;
40    }
41} else {
42    echo "最初の 'item' 要素が見つかりませんでした。" . PHP_EOL;
43}
44
45echo PHP_EOL . "--- 別の既存の名前空間付き属性 ('data:value') の取得 ---" . PHP_EOL;
46
47if ($elementWithNsAttr instanceof DOMElement) {
48    // 'data:value' 属性を名前空間URIとローカル名で取得します。
49    $dataValueAttr = $elementWithNsAttr->getAttributeNodeNS('http://data.example.com/ns', 'value');
50
51    if ($dataValueAttr instanceof DOMAttr) {
52        echo "属性名 (完全修飾名): " . $dataValueAttr->name . PHP_EOL;
53        echo "属性値: " . $dataValueAttr->nodeValue . PHP_EOL;
54        echo "属性の名前空間URI: " . $dataValueAttr->namespaceURI . PHP_EOL;
55    } else {
56        echo "data:value 属性は見つかりませんでした。" . PHP_EOL;
57    }
58}
59
60echo PHP_EOL . "--- 名前空間なしの属性 ('status') の取得 ---" . PHP_EOL;
61
62if ($elementWithoutNsAttr instanceof DOMElement) {
63    // 'status' 属性を名前空間なしで取得します。
64    // 名前空間引数には null を指定します。
65    $statusAttr = $elementWithoutNsAttr->getAttributeNodeNS(null, 'status');
66
67    if ($statusAttr instanceof DOMAttr) {
68        echo "属性名: " . $statusAttr->name . PHP_EOL;
69        echo "属性値: " . $statusAttr->nodeValue . PHP_EOL;
70        echo "属性の名前空間URI: " . ($statusAttr->namespaceURI ?? '(なし)') . PHP_EOL; // PHP 7.0+ null合体演算子
71    } else {
72        echo "status 属性は見つかりませんでした。" . PHP_EOL;
73    }
74} else {
75    echo "二番目の 'item' 要素が見つかりませんでした。" . PHP_EOL;
76}
77
78echo PHP_EOL . "--- 存在しない属性の取得 (結果は null) ---" . PHP_EOL;
79
80if ($elementWithNsAttr instanceof DOMElement) {
81    // 存在しない属性を名前空間なしで取得しようと試みます。
82    $nonExistentAttr = $elementWithNsAttr->getAttributeNodeNS(null, 'non-existent-attribute');
83
84    if ($nonExistentAttr === null) {
85        echo "non-existent-attribute 属性は存在しないため、null が返されました。" . PHP_EOL;
86    } else {
87        echo "予期せぬ属性が取得されました: " . $nonExistentAttr->name . PHP_EOL;
88    }
89}
90
91?>

DOMElement::getAttributeNodeNSメソッドは、XML要素が持つ属性の中から、特に「名前空間」を持つ属性を、その名前空間URIとローカル名で正確に取得したいときに利用されます。

第一引数$namespaceには、取得したい属性の名前空間URIを文字列で指定します。もし属性が名前空間を持たない場合はnullを指定してください。第二引数$localNameには、属性名のプレフィックス部分を除いた本来の名前（ローカル名）を文字列で指定します。

メソッドの実行結果として、指定された条件に合致する属性が見つかった場合、その属性を表すDOMAttrオブジェクトが返されます。このオブジェクトからは、属性の値（nodeValue）や完全な属性名（name）、属している名前空間URI（namespaceURI）などを参照できます。もし該当する属性が見つからなかった場合は、nullが返されます。

この機能は、XMLデータ内で名前空間が多用されている場合に、特定の属性を識別し、その値を取得する上で非常に有効です。例えば、xmlns:example="http://www.example.com/ns"と定義された要素のexample:type属性を取得するには、名前空間URIに"http://www.example.com/ns"、ローカル名に"type"を指定します。名前空間を持たない通常の属性を対象とする場合は、第一引数にnullを指定して利用します。