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

Copy
1<?php
2
3// DOMDocumentオブジェクトを作成します。これはXMLドキュメント全体を管理します。
4$dom = new DOMDocument('1.0', 'UTF-8');
5$dom->preserveWhiteSpace = false; // 出力時に不要な空白を削除
6$dom->formatOutput = true;       // 出力XMLを整形
7
8// デフォルト名前空間のURIを定義します。
9$defaultNamespaceUri = 'http://example.com/default';
10
11// デフォルト名前空間を持つルート要素を作成します。
12// 例: <root xmlns="http://example.com/default">
13$rootElement = $dom->createElementNS($defaultNamespaceUri, 'root');
14$dom->appendChild($rootElement);
15
16// ルート要素の子要素を作成します。この要素は親からデフォルト名前空間を継承します。
17// 例: <child>
18$childElement = $dom->createElementNS($defaultNamespaceUri, 'child');
19$rootElement->appendChild($childElement);
20
21// 名前空間を持たない別の要素を作成します。
22// 例: <noNamespaceElement>
23$noNamespaceElement = $dom->createElement('noNamespaceElement');
24$rootElement->appendChild($noNamespaceElement);
25
26echo "--- DOMElement::isDefaultNamespace の動作確認 ---" . PHP_EOL;
27
28// 1. rootElement が正しいデフォルト名前空間を持っているか確認します。
29echo "rootElement ('<root xmlns=\"$defaultNamespaceUri\">') が '$defaultNamespaceUri' をデフォルト名前空間として持つか: ";
30if ($rootElement->isDefaultNamespace($defaultNamespaceUri)) {
31    echo "true" . PHP_EOL; // 期待値: true
32} else {
33    echo "false" . PHP_EOL;
34}
35
36// 2. rootElement が異なる名前空間をデフォルトとして持っていないことを確認します。
37$otherNamespaceUri = 'http://example.com/other';
38echo "rootElement が '$otherNamespaceUri' をデフォルト名前空間として持つか: ";
39if ($rootElement->isDefaultNamespace($otherNamespaceUri)) {
40    echo "true" . PHP_EOL;
41} else {
42    echo "false" . PHP_EOL; // 期待値: false
43}
44
45// 3. childElement が親から継承したデフォルト名前空間を持っているか確認します。
46echo "childElement ('<child>') が '$defaultNamespaceUri' をデフォルト名前空間として持つか: ";
47if ($childElement->isDefaultNamespace($defaultNamespaceUri)) {
48    echo "true" . PHP_EOL; // 期待値: true
49} else {
50    echo "false" . PHP_EOL;
51}
52
53// 4. 名前空間を持たない要素が、どのURIもデフォルト名前空間として持っていないことを確認します。
54echo "noNamespaceElement ('<noNamespaceElement>') が '$defaultNamespaceUri' をデフォルト名前空間として持つか: ";
55if ($noNamespaceElement->isDefaultNamespace($defaultNamespaceUri)) {
56    echo "true" . PHP_EOL;
57} else {
58    echo "false" . PHP_EOL; // 期待値: false
59}
60
61// 5. 名前空間を持たない要素が、空文字列をデフォルト名前空間として持たないことを確認します。
62// XMLでは、空文字列のデフォルト名前空間は「名前空間なし」を意味しますが、
63// isDefaultNamespaceメソッドは、要素に明示的なデフォルト名前空間が設定されていない場合、常にfalseを返します。
64echo "noNamespaceElement が '' (空文字列) をデフォルト名前空間として持つか: ";
65if ($noNamespaceElement->isDefaultNamespace('')) {
66    echo "true" . PHP_EOL;
67} else {
68    echo "false" . PHP_EOL; // 期待値: false
69}
70
71// 生成されたXMLの確認 (オプション)
72// echo PHP_EOL . "--- 生成されたXML ---" . PHP_EOL;
73// echo $dom->saveXML();
74
75?>

DOMElement::isDefaultNamespaceメソッドは、XML文書内の特定の要素が、指定されたURIを「デフォルトの名前空間」として使用しているかどうかを判定します。引数として比較したい名前空間URI（文字列）を受け取り、その要素のデフォルト名前空間が引数と一致すればtrueを、そうでなければfalseをブール値として返します。

このサンプルコードでは、DOMDocumentを使ってXML構造を作成し、いくつかの要素についてisDefaultNamespaceの動作を確認しています。まず、http://example.com/defaultというURIをデフォルト名前空間として持つ<root>要素とその子要素<child>を作成します。<child>要素は親からデフォルト名前空間を継承します。次に、名前空間をまったく持たない<noNamespaceElement>要素も作成します。

コードの実行結果から、<root>要素や<child>要素のようにデフォルト名前空間が設定・継承されている要素に対して正しいURIを渡すとtrueが返されることがわかります。一方、異なるURIを渡した場合や、そもそも名前空間を持たない<noNamespaceElement>要素に対してはfalseが返されます。特に、名前空間を持たない要素に対して空文字列（''）を渡してもfalseとなることから、このメソッドが明示的にデフォルト名前空間が設定されているかをチェックする点が理解できます。このメソッドは、XMLの要素がどのデフォルト名前空間に属しているかをプログラムで確認する際に役立ちます。

Copy
1<?php
2
3// DOMDocumentオブジェクトを作成し、XML文書の構造を構築します。
4$dom = new DOMDocument('1.0', 'UTF-8');
5$dom->formatOutput = true; // 出力されるXMLを見やすく整形します
6
7// XML名前空間の定義について:
8// - デフォルト名前空間: `xmlns="http://example.com/default_ns_root"` のように、
9//   プレフィックスなしで定義された名前空間です。これは、その要素とその子孫要素のうち、
10//   自身で名前空間を定義していないプレフィックスなしの要素に適用されます。
11// - プレフィックス付き名前空間: `xmlns:p="http://example.com/prefix_ns"` のように、
12//   プレフィックス（例: 'p'）を付けて定義された名前空間です。
13//   この名前空間は、そのプレフィックスが明示的に付けられた要素に適用されます。
14
15// ルート要素を作成し、デフォルト名前空間とプレフィックス付き名前空間を定義します。
16// 'root' 要素自体は 'http://example.com/default_ns_root' をデフォルト名前空間とします。
17$root = $dom->createElementNS('http://example.com/default_ns_root', 'root');
18// プレフィックス 'p' に 'http://example.com/prefix_ns' を関連付けます。
19$root->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:p', 'http://example.com/prefix_ns');
20$dom->appendChild($root);
21
22// 1. ルート要素と同じデフォルト名前空間に属する子要素を追加します。
23// この要素は親から 'http://example.com/default_ns_root' をデフォルト名前空間として継承します。
24$child1 = $dom->createElementNS('http://example.com/default_ns_root', 'child1');
25$root->appendChild($child1);
26
27// 2. 自身で異なるデフォルト名前空間を定義する子要素を追加します。
28// この要素のデフォルト名前空間は 'http://example.com/default_ns_child' となります。
29$child2 = $dom->createElementNS('http://example.com/default_ns_child', 'child2');
30$root->appendChild($child2);
31
32// 3. プレフィックス付き名前空間に属する子要素を追加します。
33// 'p:prefixedChild' の 'p' は 'http://example.com/prefix_ns' を参照します。
34// XMLのルールにより、プレフィックスを持つ要素はデフォルト名前空間を持ちません。
35$prefixedChild = $dom->createElementNS('http://example.com/prefix_ns', 'p:prefixedChild');
36$root->appendChild($prefixedChild);
37
38// 4. 名前空間に属さない（URIが空の）子要素を追加します。
39// この要素は名前空間を持たず、isDefaultNamespace() も常に false を返します。
40$noNamespaceChild = $dom->createElement('noNamespaceChild');
41$root->appendChild($noNamespaceChild);
42
43
44echo "--- DOMElement::isDefaultNamespace() の使用例 ---\n";
45echo "================================================\n\n";
46
47// root 要素に対するテスト
48echo "--- 要素: root ('" . $root->nodeName . "') ---\n";
49echo "  名前空間 URI (namespaceURI): '" . $root->namespaceURI . "'\n";
50echo "  接頭辞 (prefix): '" . ($root->prefix ?: '(なし)') . "'\n"; // PHP 7.0+ null合体演算子
51$isDefaultRoot1 = $root->isDefaultNamespace('http://example.com/default_ns_root');
52echo "  'http://example.com/default_ns_root' はデフォルト名前空間か？: " . ($isDefaultRoot1 ? 'true' : 'false') . "\n";
53$isDefaultRoot2 = $root->isDefaultNamespace('http://example.com/prefix_ns');
54echo "  'http://example.com/prefix_ns' はデフォルト名前空間か？: " . ($isDefaultRoot2 ? 'true' : 'false') . "\n";
55$isDefaultRoot3 = $root->isDefaultNamespace(''); // 空文字列（名前空間なしを意味することも）
56echo "  '' (空文字列) はデフォルト名前空間か？: " . ($isDefaultRoot3 ? 'true' : 'false') . "\n";
57echo "\n";
58
59// child1 要素に対するテスト (ルート要素と同じデフォルト名前空間を継承)
60echo "--- 要素: child1 ('" . $child1->nodeName . "') ---\n";
61echo "  名前空間 URI: '" . $child1->namespaceURI . "'\n";
62echo "  接頭辞: '" . ($child1->prefix ?: '(なし)') . "'\n";
63$isDefaultChild1_1 = $child1->isDefaultNamespace('http://example.com/default_ns_root');
64echo "  'http://example.com/default_ns_root' はデフォルト名前空間か？: " . ($isDefaultChild1_1 ? 'true' : 'false') . "\n";
65$isDefaultChild1_2 = $child1->isDefaultNamespace('http://example.com/default_ns_child');
66echo "  'http://example.com/default_ns_child' はデフォルト名前空間か？: " . ($isDefaultChild1_2 ? 'true' : 'false') . "\n";
67echo "\n";
68
69// child2 要素に対するテスト (自身が異なるデフォルト名前空間を定義)
70echo "--- 要素: child2 ('" . $child2->nodeName . "') ---\n";
71echo "  名前空間 URI: '" . $child2->namespaceURI . "'\n";
72echo "  接頭辞: '" . ($child2->prefix ?: '(なし)') . "'\n";
73$isDefaultChild2_1 = $child2->isDefaultNamespace('http://example.com/default_ns_child');
74echo "  'http://example.com/default_ns_child' はデフォルト名前空間か？: " . ($isDefaultChild2_1 ? 'true' : 'false') . "\n";
75$isDefaultChild2_2 = $child2->isDefaultNamespace('http://example.com/default_ns_root');
76echo "  'http://example.com/default_ns_root' はデフォルト名前空間か？: " . ($isDefaultChild2_2 ? 'true' : 'false') . "\n";
77echo "\n";
78
79// prefixedChild 要素に対するテスト (プレフィックス付き要素はデフォルト名前空間を持たない)
80echo "--- 要素: prefixedChild ('" . $prefixedChild->nodeName . "') ---\n";
81echo "  名前空間 URI: '" . $prefixedChild->namespaceURI . "'\n";
82echo "  接頭辞: '" . ($prefixedChild->prefix ?: '(なし)') . "'\n";
83// プレフィックスを持つ要素のため、その要素のnamespaceURIと一致してもfalseを返します。
84$isDefaultPrefixed1 = $prefixedChild->isDefaultNamespace('http://example.com/prefix_ns');
85echo "  'http://example.com/prefix_ns' はデフォルト名前空間か？: " . ($isDefaultPrefixed1 ? 'true' : 'false') . "\n";
86$isDefaultPrefixed2 = $prefixedChild->isDefaultNamespace('');
87echo "  '' (空文字列) はデフォルト名前空間か？: " . ($isDefaultPrefixed2 ? 'true' : 'false') . "\n";
88echo "\n";
89
90// noNamespaceChild 要素に対するテスト (名前空間を持たない要素)
91echo "--- 要素: noNamespaceChild ('" . $noNamespaceChild->nodeName . "') ---\n";
92echo "  名前空間 URI: '" . ($noNamespaceChild->namespaceURI ?: '(なし)') . "'\n";
93echo "  接頭辞: '" . ($noNamespaceChild->prefix ?: '(なし)') . "'\n";
94// 名前空間を持たない要素のため、いかなるURIに対してもfalseを返します。
95$isDefaultNoNs1 = $noNamespaceChild->isDefaultNamespace('');
96echo "  '' (空文字列) はデフォルト名前空間か？: " . ($isDefaultNoNs1 ? 'true' : 'false') . "\n";
97$isDefaultNoNs2 = $noNamespaceChild->isDefaultNamespace('http://example.com/default_ns_root');
98echo "  'http://example.com/default_ns_root' はデフォルト名前空間か？: " . ($isDefaultNoNs2 ? 'true' : 'false') . "\n";
99echo "\n";
100
101
102echo "--- 生成されたXMLドキュメント ---\n";
103echo $dom->saveXML();
104

PHPのDOMElement::isDefaultNamespaceメソッドは、XML要素が特定のURIをデフォルト名前空間として持っているかどうかを判定します。引数$namespaceには検証したい名前空間URIを文字列で指定し、そのURIが要素のデフォルト名前空間と一致すればtrueを、そうでなければfalseをブール値で返します。

XMLの名前空間には、要素にプレフィックスを付けずに適用される「デフォルト名前空間」と、プレフィックスを付けて適用される「プレフィックス付き名前空間」があります。このメソッドは、要素がプレフィックスなしで属する名前空間が何かを確認するために使用します。

サンプルコードでは、DOMDocumentを使って様々な種類のXML要素を作成し、isDefaultNamespaceメソッドの挙動を確認しています。親要素からデフォルト名前空間を継承する子要素や、自身で異なるデフォルト名前空間を定義する子要素に対する挙動が示されています。特に重要な点として、プレフィックスを持つ要素はデフォルト名前空間を持たないため、たとえ要素の実際の名前空間URIを渡してもfalseを返します。また、そもそも名前空間に属さない要素に対しても、このメソッドは常にfalseを返します。これにより、要素のデフォルト名前空間の判定ロジックを正確に理解することができます。