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

Copy
1<?php
2
3// DOMDocument オブジェクトを作成し、XMLを整形して出力するように設定します。
4$dom = new DOMDocument('1.0', 'UTF-8');
5$dom->formatOutput = true;
6
7// XMLドキュメントのルート要素を作成し、デフォルト名前空間を定義します。
8// 例: <root xmlns="http://example.com/default_ns">
9$defaultNamespaceURI = 'http://example.com/default_ns';
10$rootElement = $dom->createElementNS($defaultNamespaceURI, 'root');
11$dom->appendChild($rootElement);
12
13// ルート要素の子要素を作成します。この要素は親のデフォルト名前空間を継承します。
14$childElement = $dom->createElement('item'); // 名前空間プレフィックスなし
15$rootElement->appendChild($childElement);
16
17// 子要素にテキストノードを追加します。
18// このテキストノードは、その親要素が持つデフォルト名前空間を継承します。
19$textNode = $dom->createTextNode('This is some text within the default namespace.');
20$childElement->appendChild($textNode);
21
22// 生成されたXMLの構造を確認します。
23echo "--- Generated XML ---" . PHP_EOL;
24echo $dom->saveXML();
25echo PHP_EOL;
26
27// DOMText::isDefaultNamespace() メソッドの使用例
28echo "--- Checking DOMText::isDefaultNamespace() ---" . PHP_EOL;
29
30// 1. テキストノードが、定義したデフォルト名前空間に属しているかを確認します。
31echo "Checking if '{$textNode->nodeValue}' is in default namespace '{$defaultNamespaceURI}': ";
32if ($textNode->isDefaultNamespace($defaultNamespaceURI)) {
33    echo "TRUE - テキストノードは指定されたデフォルト名前空間に属しています。" . PHP_EOL;
34} else {
35    echo "FALSE - テキストノードは指定されたデフォルト名前空間に属していません。" . PHP_EOL;
36}
37
38// 2. テキストノードが、別の名前空間に属しているかをチェックします。
39$anotherNamespaceURI = 'http://example.com/another_ns';
40echo "Checking if '{$textNode->nodeValue}' is in default namespace '{$anotherNamespaceURI}': ";
41if ($textNode->isDefaultNamespace($anotherNamespaceURI)) {
42    echo "TRUE - テキストノードは別の名前空間に属しています。" . PHP_EOL;
43} else {
44    echo "FALSE - テキストノードは別の名前空間には属していません。" . PHP_EOL;
45}
46

DOMText::isDefaultNamespaceメソッドは、PHPのDOM拡張機能において、XMLドキュメント内のテキストノードが特定のデフォルト名前空間に属しているかを判定するために使用されます。このメソッドはDOMTextクラスに属し、string $namespaceURIという引数を受け取ります。この引数には、チェックしたい名前空間のURIを指定します。メソッドは、テキストノードが指定されたデフォルト名前空間に属していればtrueを、そうでなければfalseをブール値で返します。

XMLでは、要素や属性がどの名前空間に属するかが重要ですが、テキストノードもその親要素のデフォルト名前空間を継承します。サンプルコードでは、まずDOMDocumentオブジェクトでXMLドキュメントを作成し、http://example.com/default_nsというURIをデフォルト名前空間として持つルート要素を定義しています。このルート要素の子要素に続くテキストノードは、このデフォルト名前空間を継承しています。

その後、$textNode->isDefaultNamespace($defaultNamespaceURI)を呼び出し、テキストノードが定義したデフォルト名前空間に属しているかを確認します。継承しているため、このチェックではtrueが返され、「テキストノードは指定されたデフォルト名前空間に属しています」と出力されます。一方、存在しない別の名前空間URIでチェックした場合はfalseが返され、メソッドがテキストノードの正しい名前空間所属状態を正確に判定していることを示します。

Copy
1<?php
2
3/**
4 * DOMText::isDefaultNamespace メソッドのサンプルコード
5 *
6 * このスクリプトは、XMLドキュメント内のDOMTextノードが特定のURIをデフォルト名前空間として
7 * 持っているかどうかを `isDefaultNamespace` メソッドを使用して確認する方法を示します。
8 *
9 * DOMTextノード自身は直接名前空間を持ちませんが、その親要素の名前空間コンテキストを継承します。
10 * XMLにおける名前空間の「定義 (define namespace)」と、それが「デフォルトであるかの確認」の例です。
11 */
12
13// 1. DOMDocument オブジェクトの準備
14// XMLドキュメントを構築するためのDOMDocumentオブジェクトを作成します。
15$dom = new DOMDocument('1.0', 'UTF-8');
16$dom->formatOutput = true; // 出力を見やすく整形します。
17
18// 2. デフォルト名前空間を持つ要素とそのテキストノード
19// XML上で `xmlns="http://example.com/default"` のように、デフォルト名前空間を定義します。
20$defaultNamespaceUri = 'http://example.com/default';
21$rootElement = $dom->createElementNS($defaultNamespaceUri, 'root');
22$dom->appendChild($rootElement);
23
24// ルート要素内にテキストノードを追加します。
25$defaultTextContent = 'これはデフォルト名前空間を持つ要素内のテキストです。';
26$defaultTextNode = $dom->createTextNode($defaultTextContent);
27$rootElement->appendChild($defaultTextNode);
28
29// 3. プレフィックス付き名前空間を持つ要素とそのテキストノード
30// XML上で `xmlns:prefix="http://example.com/prefix"` のように、プレフィックス付き名前空間を定義します。
31// これは要素の「デフォルト名前空間」とは異なるため、isDefaultNamespace は false を返します。
32$prefixNamespaceUri = 'http://example.com/prefix';
33$childElement = $dom->createElementNS($prefixNamespaceUri, 'prefix:child');
34$rootElement->appendChild($childElement);
35
36// プレフィックス付き名前空間を持つ子要素内にテキストノードを追加します。
37$prefixedTextContent = 'これはプレフィックス付き名前空間の要素内のテキストです。';
38$prefixedTextNode = $dom->createTextNode($prefixedTextContent);
39$childElement->appendChild($prefixedTextNode);
40
41// 4. 名前空間を持たない要素とそのテキストノード
42// XML上で名前空間が定義されていない要素です。
43$noNamespaceElement = $dom->createElement('noNamespace');
44$dom->appendChild($noNamespaceElement);
45
46// 名前空間を持たない要素内にテキストノードを追加します。
47$noNamespaceTextContent = 'これは名前空間を持たない要素内のテキストです。';
48$noNamespaceTextNode = $dom->createTextNode($noNamespaceTextContent);
49$noNamespaceElement->appendChild($noNamespaceTextNode);
50
51
52echo "--- 生成されたXMLドキュメント ---\n";
53echo $dom->saveXML() . "\n";
54echo "---------------------------------\n\n";
55
56
57echo "--- DOMText::isDefaultNamespace メソッドのテスト ---\n";
58
59// テストケース1: デフォルト名前空間を持つ要素内のテキストノード
60echo "\n[1] デフォルト名前空間を持つ要素内のテキストノード ('{$defaultTextContent}')\n";
61echo "  - 期待されるデフォルト名前空間URI: '{$defaultNamespaceUri}'\n";
62
63$isDefault1 = $defaultTextNode->isDefaultNamespace($defaultNamespaceUri);
64echo "  - isDefaultNamespace('{$defaultNamespaceUri}'): " . ($isDefault1 ? "true (このURIはデフォルト名前空間です)" : "false (このURIはデフォルト名前空間ではありません)") . "\n";
65
66$isDefault2 = $defaultTextNode->isDefaultNamespace('http://example.com/another');
67echo "  - isDefaultNamespace('http://example.com/another'): " . ($isDefault2 ? "true (誤り)" : "false (このURIはデフォルト名前空間ではありません)") . "\n";
68
69
70// テストケース2: プレフィックス付き名前空間を持つ要素内のテキストノード
71echo "\n[2] プレフィックス付き名前空間を持つ要素内のテキストノード ('{$prefixedTextContent}')\n";
72echo "  - 親要素はプレフィックス 'prefix' で '{$prefixNamespaceUri}' を使用していますが、\n";
73echo "    これは「デフォルト名前空間」ではないため、isDefaultNamespace は false を返します。\n";
74
75$isDefault3 = $prefixedTextNode->isDefaultNamespace($prefixNamespaceUri);
76echo "  - isDefaultNamespace('{$prefixNamespaceUri}'): " . ($isDefault3 ? "true (誤り)" : "false (このURIはデフォルト名前空間ではありません)") . "\n";
77
78$isDefault4 = $prefixedTextNode->isDefaultNamespace(''); // 名前空間なし
79echo "  - isDefaultNamespace(''): " . ($isDefault4 ? "true (誤り)" : "false (このURIはデフォルト名前空間ではありません)") . "\n";
80
81
82// テストケース3: 名前空間を持たない要素内のテキストノード
83echo "\n[3] 名前空間を持たない要素内のテキストノード ('{$noNamespaceTextContent}')\n";
84echo "  - XMLで名前空間が宣言されていない場合、空文字列 ('') がデフォルト名前空間とみなされます。\n";
85
86$isDefault5 = $noNamespaceTextNode->isDefaultNamespace('');
87echo "  - isDefaultNamespace(''): " . ($isDefault5 ? "true (このURIはデフォルト名前空間です)" : "false (このURIはデフォルト名前空間ではありません)") . "\n";
88
89$isDefault6 = $noNamespaceTextNode->isDefaultNamespace('http://example.com/any');
90echo "  - isDefaultNamespace('http://example.com/any'): " . ($isDefault6 ? "true (誤り)" : "false (このURIはデフォルト名前空間ではありません)") . "\n";
91
92?>

PHPのDOMText::isDefaultNamespaceメソッドは、XMLドキュメント内のテキストノードが、特定のURIをデフォルト名前空間として持っているかを確認します。テキストノード自身は直接名前空間を持ちませんが、その親要素が持つ名前空間のコンテキストを継承して判断されます。

このメソッドは引数としてstring $namespaceURIを受け取り、確認したい名前空間のURIを指定します。戻り値はbool型で、指定されたURIがノードのデフォルト名前空間であればtrueを、そうでなければfalseを返します。

具体的には、親要素がxmlns="http://example.com/default"のようにデフォルト名前空間を定義している場合、そのURIに対してisDefaultNamespaceはtrueとなります。xmlns:prefix="http://example.com/prefix"のようにプレフィックス付きで名前空間が定義されている場合は、それはデフォルト名前空間ではないためfalseを返します。また、親要素がXML上で名前空間を一切宣言していない場合、空文字列''がデフォルト名前空間とみなされ、isDefaultNamespace('')はtrueを返します。このメソッドは、XMLにおける名前空間の「定義」と「デフォルト名前空間の確認」に利用されます。