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

Copy
1<?php
2
3/**
4 * Dom\CharacterData::isDefaultNamespace メソッドの使用例を示す関数。
5 * XMLドキュメントでデフォルト名前空間がどのように扱われるかを示します。
6 */
7function demonstrateCharacterDataIsDefaultNamespace(): void
8{
9    // 1. デフォルト名前空間を持つXMLドキュメントを作成
10    // 'xmlns="http://example.com/ns1"' でルート要素とその子要素にデフォルト名前空間を定義します。
11    $dom = new DOMDocument();
12    $xmlString = '<root xmlns="http://example.com/ns1"><child>Sample Text Data</child></root>';
13    $dom->loadXML($xmlString);
14
15    echo "--- Original XML Document ---\n";
16    echo $dom->saveXML() . "\n\n";
17
18    // 2. DOMドキュメントから Dom\CharacterData のインスタンス（Dom\Textノード）を取得
19    // 'child' 要素の最初の子ノードがテキストノードです。
20    $childElement = $dom->getElementsByTagName('child')->item(0);
21
22    // テキストノードが存在し、かつ Dom\CharacterData のインスタンスであることを確認
23    if ($childElement && $childElement->firstChild instanceof Dom\CharacterData) {
24        /** @var Dom\CharacterData $characterDataNode */
25        $characterDataNode = $childElement->firstChild;
26
27        echo "Checking Dom\\CharacterData::isDefaultNamespace for the text node:\n";
28        echo "- Node Value: '{$characterDataNode->nodeValue}'\n";
29        echo "- Node Type (nodeName): '{$characterDataNode->nodeName}'\n"; // テキストノードの場合 '#text'
30        echo "- Parent Element Namespace URI: '{$childElement->namespaceURI}'\n\n";
31
32        // 3. isDefaultNamespace メソッドの呼び出し例
33
34        // Case 1: ノードの親要素のデフォルト名前空間と同じURIをチェック
35        // このURIはXMLで定義されたデフォルト名前空間と一致します。
36        $defaultNamespaceUri = 'http://example.com/ns1';
37        $isDefault = $characterDataNode->isDefaultNamespace($defaultNamespaceUri);
38        echo "Is '{$defaultNamespaceUri}' the default namespace? " . ($isDefault ? 'Yes' : 'No') . " (Expected: Yes)\n";
39
40        // Case 2: 異なる名前空間URIをチェック
41        // これはXMLで定義されたデフォルト名前空間とは一致しません。
42        $anotherNamespaceUri = 'http://example.com/ns2';
43        $isDefault = $characterDataNode->isDefaultNamespace($anotherNamespaceUri);
44        echo "Is '{$anotherNamespaceUri}' the default namespace? " . ($isDefault ? 'Yes' : 'No') . " (Expected: No)\n";
45
46        // Case 3: nullを引数に渡す
47        // PHPのDom\CharacterData::isDefaultNamespaceドキュメントによると、
48        // 引数 `namespace` が `null` の場合、このメソッドは常に `false` を返します。
49        $isDefault = $characterDataNode->isDefaultNamespace(null);
50        echo "Is null the default namespace? " . ($isDefault ? 'Yes' : 'No') . " (Expected: No)\n";
51
52        // Case 4: 空文字列を引数に渡す
53        // 空文字列は有効な名前空間URIとは見なされず、現在のデフォルト名前空間とは一致しません。
54        $emptyStringNamespace = '';
55        $isDefault = $characterDataNode->isDefaultNamespace($emptyStringNamespace);
56        echo "Is '' (empty string) the default namespace? " . ($isDefault ? 'Yes' : 'No') . " (Expected: No)\n";
57
58    } else {
59        echo "Error: Could not find a Dom\\CharacterData node (text node) in the document or it's not a Dom\\CharacterData instance.\n";
60    }
61}
62
63// サンプル関数の実行
64demonstrateCharacterDataIsDefaultNamespace();
65

Dom\CharacterData::isDefaultNamespace メソッドは、XMLドキュメント内の文字データノードが特定のデフォルト名前空間に属するかどうかを確認するために使用されます。XMLの名前空間は、要素や属性の名前の衝突を避けるための仕組みで、特にプレフィックスなしで定義された名前空間は「デフォルト名前空間」と呼ばれ、その範囲内の要素に適用されます。

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

サンプルコードでは、まず http://example.com/ns1 をデフォルト名前空間として定義したXMLドキュメントを作成しています。そして、そのドキュメント内のテキストノード（Dom\CharacterData のインスタンス）を取得し、いくつかのケースで isDefaultNamespace メソッドを呼び出しています。親要素のデフォルト名前空間と一致するURIを与えた場合は true となり、異なるURI、null、あるいは空文字列を与えた場合は false となることが示されており、引数の挙動が明確に理解できます。特に null や空文字列はデフォルト名前空間とはみなされません。

Copy
1<?php
2
3/**
4 * Dom\CharacterData::isDefaultNamespace の使用例を示します。
5 * XML文書におけるデフォルト名前空間の概念と、ノードがそれに属するかを判定する方法をデモンストレーションします。
6 * システムエンジニアを目指す初心者にも理解しやすいように、具体的なXML要素と名前空間の定義から説明します。
7 */
8function demonstrateDomDefaultNamespace(): void
9{
10    // 1. 新しいDOMドキュメントを作成します。XML文書を扱うための基盤です。
11    $dom = new Dom\Document('1.0', 'UTF-8');
12
13    // 2. デフォルト名前空間を定義したルート要素を作成します。
14    //    'http://www.example.com/my-default-ns' がこの要素とその子要素のデフォルト名前空間となります。
15    $defaultNamespaceUri = 'http://www.example.com/my-default-ns';
16    $rootElement = $dom->createElementNS($defaultNamespaceUri, 'my:root');
17    $dom->appendChild($rootElement);
18
19    // 3. ルート要素にテキストノードを追加します。
20    //    Dom\Text は Dom\CharacterData のサブクラスです。
21    //    テキストノードは通常、親要素の名前空間を継承します。
22    $textNode = $dom->createTextNode('これはデフォルト名前空間内のテキストです。');
23    $rootElement->appendChild($textNode);
24
25    echo "--- デフォルト名前空間の確認 ---\n";
26
27    // 4. Textノードがデフォルト名前空間に属しているかを確認します。
28    //    isDefaultNamespace メソッドは、指定されたURIがノードのデフォルト名前空間である場合に true を返します。
29    $isDefaultMatch = $textNode->isDefaultNamespace($defaultNamespaceUri);
30    echo "ノードはデフォルトURI ('{$defaultNamespaceUri}') のデフォルト名前空間ですか？ " . ($isDefaultMatch ? 'はい' : 'いいえ') . "\n";
31
32    // 5. 別のURIがデフォルト名前空間であるかを確認します。
33    //    ノードのデフォルト名前空間とは異なるため、false が返されます。
34    $otherNamespaceUri = 'http://www.example.com/other-ns';
35    $isDefaultMismatch = $textNode->isDefaultNamespace($otherNamespaceUri);
36    echo "ノードは別のURI ('{$otherNamespaceUri}') のデフォルト名前空間ですか？ " . ($isDefaultMismatch ? 'はい' : 'いいえ') . "\n";
37
38    // 6. null を渡して、ノードが「名前空間なし」の状態であるかを確認します。
39    //    今回のテキストノードはデフォルト名前空間に属しているので、false が返されます。
40    $isDefaultNull = $textNode->isDefaultNamespace(null);
41    echo "ノードは名前空間が指定されていない状態 (null) がデフォルト名前空間ですか？ " . ($isDefaultNull ? 'はい' : 'いいえ') . "\n";
42
43    echo "\n--- 名前空間を持たないノードの確認 ---\n";
44
45    // 7. 名前空間を定義しない要素とテキストノードを作成します。
46    $noNamespaceElement = $dom->createElement('noNamespaceRoot');
47    $dom->appendChild($noNamespaceElement);
48    $noNamespaceTextNode = $dom->createTextNode('これは名前空間を持たないテキストです。');
49    $noNamespaceElement->appendChild($noNamespaceTextNode);
50
51    // 8. 名前空間を持たないテキストノードに対して isDefaultNamespace(null) を確認します。
52    //    名前空間を持たないノードは、null がデフォルト名前空間と解釈されるため、true が返されます。
53    $isNoNamespaceDefaultNull = $noNamespaceTextNode->isDefaultNamespace(null);
54    echo "名前空間を持たないノードは名前空間が指定されていない状態 (null) がデフォルト名前空間ですか？ " . ($isNoNamespaceDefaultNull ? 'はい' : 'いいえ') . "\n";
55
56    // 9. 名前空間を持たないテキストノードに対して、定義されたURIを渡した場合。
57    //    名前空間を持たないため、false が返されます。
58    $isNoNamespaceDefaultUri = $noNamespaceTextNode->isDefaultNamespace($defaultNamespaceUri);
59    echo "名前空間を持たないノードはデフォルトURI ('{$defaultNamespaceUri}') のデフォルト名前空間ですか？ " . ($isNoNamespaceDefaultUri ? 'はい' : 'いいえ') . "\n";
60}
61
62// 関数を実行して、上記で定義された動作を確認します。
63demonstrateDomDefaultNamespace();
64
65?>

Dom\CharacterData::isDefaultNamespaceメソッドは、XML文書内のノードが特定のデフォルト名前空間に属するかどうかを判定するために使用されます。XMLにおけるデフォルト名前空間とは、明示的なプレフィックスが指定されていない要素が属する名前空間を指します。

このメソッドは、引数$namespaceに比較したい名前空間のURI（文字列）またはnullを指定して呼び出します。ノードが指定されたURIをデフォルト名前空間として持つ場合、戻り値としてtrue（真）を返します。そうでない場合はfalse（偽）を返します。引数にnullを渡すと、ノードが「名前空間を持たない」状態であるかを判定できます。

サンプルコードでは、まず特定のURIをデフォルト名前空間として設定したXMLのルート要素と、その子であるテキストノードを作成しています。このテキストノードに対してisDefaultNamespaceを呼び出し、設定したURIを渡すとtrueが、異なるURIやnullを渡すとfalseが返されることを確認できます。さらに、名前空間を全く持たないテキストノードを作成し、それに対してisDefaultNamespace(null)を呼び出すとtrueが返されることを示しています。これにより、XMLノードがどの名前空間に属しているか、あるいは名前空間が定義されていないかを効果的に判別することが可能です。