【PHP8.x】DOMNode::namespaceURIプロパティの使い方

Copy
1<?php
2
3/**
4 * DOMNode::namespaceURIプロパティを使って、XMLの名前空間URIを取得する方法を示します。
5 *
6 * PHPにおける「名前空間 (namespace)」という言葉は、PHP言語自体の名前空間機能と、
7 * XMLのDOM操作で扱うXMLの名前空間の二つの文脈で使われることがあります。
8 * このコードは後者のXMLの名前空間について、DOMNode::namespaceURIプロパティの動作を通じて解説します。
9 *
10 * XMLの名前空間は、異なるXML語彙の要素や属性が衝突しないようにするために使用されます。
11 * 例えば、異なるスキーマから来た要素に同じ名前があった場合でも、名前空間で区別できます。
12 * namespaceURIは、ノード（要素や属性）が属する名前空間のURIを返します。
13 * 名前空間に属さないノードの場合にはnullを返します。
14 */
15function demonstrateDomNamespaceUri(): void
16{
17    // 名前空間を持つ要素や属性、持たない要素や属性を含むXML文字列を定義します。
18    // xmlns:ns1="http://example.com/ns1" は "ns1" というプレフィックスを
19    // "http://example.com/ns1" というURIに関連付けています。
20    // xmlns="http://example.com/default-ns" は、プレフィックスなしの要素の
21    // デフォルト名前空間を "http://example.com/default-ns" に設定しています。
22    $xmlString = <<<XML
23<root xmlns:ns1="http://example.com/ns1" xmlns="http://example.com/default-ns">
24    <ns1:element1 attr1="value1" ns1:attr2="value2">
25        Content for element1 (with ns1 prefix)
26    </ns1:element1>
27    <element2 attr3="value3" ns1:attr4="value4">
28        <subElement>Sub Content (inherits default namespace)</subElement>
29    </element2>
30    <noNamespaceElement>
31        <childWithoutNs />
32    </noNamespaceElement>
33</root>
34XML;
35
36    // DOMDocumentオブジェクトを作成し、XML文字列をロードします。
37    $dom = new DOMDocument();
38    $dom->loadXML($xmlString);
39
40    // --- 各種ノードのnamespaceURIを取得して表示します ---
41
42    // 1. ルート要素のnamespaceURIを取得
43    // root要素はデフォルト名前空間 "http://example.com/default-ns" に属します。
44    $rootElement = $dom->documentElement;
45    echo "--- Root Element: '{$rootElement->nodeName}' ---\n";
46    echo "  Namespace URI: " . ($rootElement->namespaceURI ?? 'null') . "\n\n";
47
48    // 2. ns1:element1のnamespaceURIを取得
49    // getElementsByTagNameNSを使って、特定の名前空間とタグ名で要素を取得します。
50    $element1 = $dom->getElementsByTagNameNS('http://example.com/ns1', 'element1')->item(0);
51    if ($element1) {
52        echo "--- Element: '{$element1->nodeName}' (with prefix ns1) ---\n";
53        echo "  Namespace URI: " . ($element1->namespaceURI ?? 'null') . "\n";
54
55        // element1の属性のnamespaceURIも確認
56        // attr1はプレフィックスがないため、XMLの規則により名前空間URIはnullです。
57        $attr1 = $element1->getAttributeNode('attr1');
58        echo "  Attribute '{$attr1->nodeName}' Namespace URI: " . ($attr1->namespaceURI ?? 'null') . "\n";
59        // ns1:attr2はプレフィックスを持つため、関連付けられた名前空間URIを持ちます。
60        $attr2 = $element1->getAttributeNode('ns1:attr2');
61        echo "  Attribute '{$attr2->nodeName}' Namespace URI: " . ($attr2->namespaceURI ?? 'null') . "\n\n";
62    }
63
64    // 3. element2のnamespaceURIを取得 (デフォルト名前空間の要素)
65    // root要素で定義されたデフォルト名前空間に属します。
66    $element2 = $dom->getElementsByTagNameNS('http://example.com/default-ns', 'element2')->item(0);
67    if ($element2) {
68        echo "--- Element: '{$element2->nodeName}' (default namespace) ---\n";
69        echo "  Namespace URI: " . ($element2->namespaceURI ?? 'null') . "\n";
70
71        // element2の属性のnamespaceURIも確認
72        // attr3はプレフィックスがないため、XMLの規則により名前空間URIはnullです。
73        $attr3 = $element2->getAttributeNode('attr3');
74        echo "  Attribute '{$attr3->nodeName}' Namespace URI: " . ($attr3->namespaceURI ?? 'null') . "\n";
75        // ns1:attr4はプレフィックスを持ち、ns1名前空間に属します。
76        $attr4 = $element2->getAttributeNode('ns1:attr4');
77        echo "  Attribute '{$attr4->nodeName}' Namespace URI: " . ($attr4->namespaceURI ?? 'null') . "\n\n";
78
79        // subElementのnamespaceURIを取得 (親からデフォルト名前空間を継承)
80        $subElement = $element2->getElementsByTagName('subElement')->item(0);
81        if ($subElement) {
82            echo "--- Element: '{$subElement->nodeName}' (inherits default namespace) ---\n";
83            echo "  Namespace URI: " . ($subElement->namespaceURI ?? 'null') . "\n\n";
84        }
85    }
86
87    // 4. noNamespaceElementのnamespaceURIを取得 (名前空間なしの要素)
88    // 名前空間宣言がないため、namespaceURIはnullです。
89    $noNsElement = $dom->getElementsByTagName('noNamespaceElement')->item(0);
90    if ($noNsElement) {
91        echo "--- Element: '{$noNsElement->nodeName}' (no explicit namespace) ---\n";
92        echo "  Namespace URI: " . ($noNsElement->namespaceURI ?? 'null') . "\n";
93
94        // childWithoutNsも名前空間を持たない要素です。
95        $childNoNs = $noNsElement->getElementsByTagName('childWithoutNs')->item(0);
96        if ($childNoNs) {
97            echo "--- Element: '{$childNoNs->nodeName}' (child without namespace) ---\n";
98            echo "  Namespace URI: " . ($childNoNs->namespaceURI ?? 'null') . "\n\n";
99        }
100    }
101}
102
103// 関数を実行して結果を表示します。
104demonstrateDomNamespaceUri();

DOMNode::namespaceURIは、PHPのDOM拡張機能において、XMLドキュメント内の各ノードが所属する名前空間のURI（Uniform Resource Identifier）を取得するためのプロパティです。引数はなく、ノードが名前空間に属していればそのURIを表す文字列を、名前空間に属していなければnullを返します。

PHPにおける「名前空間」という言葉は、PHP言語自体のコード整理機能としての名前空間と、XMLのDOM操作で扱うXMLの名前空間の二つの文脈で使われますが、このプロパティは後者のXMLの名前空間に関するものです。XMLの名前空間は、異なるXML語彙の要素や属性の名前が衝突しないように区別するために利用されます。

提供されたサンプルコードでは、名前空間を持つ要素や属性、持たない要素や属性を含むXML文字列をPHPのDOMDocumentでロードし、各ノードのnamespaceURIプロパティの挙動を示しています。例えば、xmlns:ns1="http://example.com/ns1"のように定義された名前空間に属するns1:element1のような要素やns1:attr2のような属性は、対応するURIを返します。また、xmlns="http://example.com/default-ns"で定義されたデフォルト名前空間に属するelement2やその子要素subElementも、そのURIを返します。一方、プレフィックスを持たない属性（例: attr1）や、名前空間が明示的に定義されていない要素（例: noNamespaceElement）は、nullを返すことが確認でき、XMLの構造を正確に解析する際に役立ちます。

Copy
1<?php
2
3/**
4 * DOMNode::namespaceURI プロパティの利用例を示します。
5 * このプロパティは、XML名前空間が設定された要素や属性のURIを返します。
6 * 名前空間がない場合は null を返します。
7 *
8 * システムエンジニアを目指す初心者が、XMLにおける名前空間の概念と
9 * PHPのDOM拡張機能を使ってそれらをどのように操作・確認するかを理解するのに役立ちます。
10 */
11function demonstrateDomNamespaceUri(): void
12{
13    // 新しいDOMドキュメントを作成します。
14    // XMLバージョン1.0, エンコーディングUTF-8を指定。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    // 出力されるXMLを見やすくするために、整形を有効にします。
17    $dom->formatOutput = true;
18
19    // XML名前空間のURIと、それに対応するプレフィックスを定義します。
20    // URIは名前空間を一意に識別するためのものです。
21    $xmlNamespaceUri = 'http://example.com/data';
22    $xmlNamespacePrefix = 'app';
23
24    // ルート要素を作成します。createElementNS() を使用して、
25    // 指定した名前空間 (URIとプレフィックス) を持つ要素を作成します。
26    // この要素は `<app:root xmlns:app="http://example.com/data">` のようになります。
27    $rootElement = $dom->createElementNS($xmlNamespaceUri, $xmlNamespacePrefix . ':root');
28    // ドキュメントにこのルート要素を追加します。
29    $dom->appendChild($rootElement);
30
31    // 名前空間を持つ子要素を作成し、ルート要素に追加します。
32    // 例: `<app:item>Hello XML Namespace!</app:item>`
33    $childElementWithNs = $dom->createElementNS($xmlNamespaceUri, $xmlNamespacePrefix . ':item', 'Hello XML Namespace!');
34    $rootElement->appendChild($childElementWithNs);
35
36    // 名前空間を持たない子要素を作成し、ルート要素に追加します。
37    // 例: `<plainItem>No Namespace</plainItem>`
38    $childElementWithoutNs = $dom->createElement('plainItem', 'No Namespace');
39    $rootElement->appendChild($childElementWithoutNs);
40
41    // 名前空間を持つ属性のためのURIとプレフィックスを定義します。
42    $attrNamespaceUri = 'http://example.com/attributes';
43    $attrNamespacePrefix = 'attr';
44
45    // 名前空間を持つ属性を作成します。createAttributeNS() を使用。
46    // この属性は `attr:id="item-123"` のようになります。
47    $attributeWithNs = $dom->createAttributeNS($attrNamespaceUri, $attrNamespacePrefix . ':id');
48    $attributeWithNs->value = 'item-123';
49    // この属性を、名前空間を持つ子要素に追加します。
50    $childElementWithNs->appendChild($attributeWithNs);
51
52    // 生成されたXMLドキュメントの内容を出力します。
53    echo "--- 生成されたXMLドキュメント ---\n";
54    echo $dom->saveXML();
55    echo "----------------------------------\n\n";
56
57    echo "--- DOMNode::namespaceURI の結果 ---\n";
58
59    // 1. ルート要素の namespaceURI を確認します。
60    // 期待値: 'http://example.com/data'
61    echo "要素 '" . $rootElement->nodeName . "' の namespaceURI: " . var_export($rootElement->namespaceURI, true) . "\n";
62
63    // 2. 名前空間を持つ子要素の namespaceURI を確認します。
64    // 期待値: 'http://example.com/data'
65    echo "要素 '" . $childElementWithNs->nodeName . "' の namespaceURI: " . var_export($childElementWithNs->namespaceURI, true) . "\n";
66
67    // 3. 名前空間を持たない子要素の namespaceURI を確認します。
68    // 期待値: null (名前空間が定義されていないため)
69    echo "要素 '" . $childElementWithoutNs->nodeName . "' の namespaceURI: " . var_export($childElementWithoutNs->namespaceURI, true) . "\n";
70
71    // 4. 名前空間を持つ属性の namespaceURI を確認します。
72    // 期待値: 'http://example.com/attributes'
73    echo "属性 '" . $attributeWithNs->nodeName . "' の namespaceURI: " . var_export($attributeWithNs->namespaceURI, true) . "\n";
74
75    // 5. テキストノードの namespaceURI を確認します。
76    // テキストノードは名前空間を持たないので、常に null です。
77    $textNode = $dom->createTextNode('単なるテキストコンテンツ');
78    echo "テキストノード ('" . $textNode->nodeName . "') の namespaceURI: " . var_export($textNode->namespaceURI, true) . "\n";
79
80    // 6. コメントノードの namespaceURI を確認します。
81    // コメントノードも名前空間を持たないので、常に null です。
82    $commentNode = $dom->createComment('これはXML内のコメントです');
83    echo "コメントノード ('" . $commentNode->nodeName . "') の namespaceURI: " . var_export($commentNode->namespaceURI, true) . "\n";
84}
85
86// 上記の関数を実行し、DOMNode::namespaceURI プロパティの動作を確認します。
87demonstrateDomNamespaceUri();

PHPのDOMNode::namespaceURIプロパティは、XMLの名前空間（namespace）に関する重要な情報を提供します。このプロパティは、DOMNodeクラスに属し、XML要素や属性に設定されている名前空間のURIを文字列として返します。名前空間は、異なるXML語彙の要素や属性が混在する際に、それらを一意に区別するために使用される識別子です。

namespaceURIプロパティは引数を取らず、戻り値として、ノードに名前空間が設定されていればそのURIを示す文字列を返します。名前空間が設定されていないノード（例えば、通常の要素や属性、またはテキストノードやコメントノードなど）の場合は、nullを返します。

サンプルコードでは、まずDOMDocumentを作成し、createElementNSやcreateAttributeNSメソッドを用いて、特定のURIを持つ名前空間付きの要素や属性を生成しています。また、createElementで名前空間を持たない要素も作成しています。その後、それぞれのノードに対してnamespaceURIプロパティにアクセスし、その値を表示しています。これにより、名前空間が設定されたノードからは対応するURIが、設定されていないノードからはnullが返される挙動が確認できます。このプロパティを利用することで、プログラムからXMLドキュメント内のノードがどの名前空間に属しているかを正確に判別することが可能になります。