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

Copy
1<?php
2
3// Dom\Node::isDefaultNamespace メソッドは、指定された名前空間URIがノードのデフォルト名前空間であるかどうかをチェックします。
4// 引数に null を渡すと、ノードがデフォルトの名前空間を持つかどうか（つまり、名前空間プレフィックスなしで名前空間が適用されているか）をチェックします。
5
6function demonstrateIsDefaultNamespace(): void
7{
8    // 1. デフォルト名前空間を持つXMLドキュメントを作成
9    $doc = new DOMDocument();
10    // 'root'要素にデフォルト名前空間 'http://example.com/default-ns' を定義
11    $xmlString = '<root xmlns="http://example.com/default-ns">
12                      <child>This is a child node.</child>
13                  </root>';
14    $doc->loadXML($xmlString);
15
16    // ルート要素を取得 (Dom\Node のサブクラスである DOMElement インスタンス)
17    $rootElement = $doc->documentElement;
18
19    echo "--- ルート要素 ('{$rootElement->nodeName}') ---" . PHP_EOL;
20
21    // ケース1: 引数に null を渡す
22    // このノードはデフォルト名前空間を持っているため、true が期待されます。
23    $isDefaultNsNull = $rootElement->isDefaultNamespace(null);
24    echo "isDefaultNamespace(null): " . ($isDefaultNsNull ? 'true' : 'false') . " (期待値: true)" . PHP_EOL;
25
26    // ケース2: デフォルト名前空間のURIを渡す
27    // ノードのデフォルト名前空間と一致するため、true が期待されます。
28    $defaultNsUri = "http://example.com/default-ns";
29    $isDefaultNsMatch = $rootElement->isDefaultNamespace($defaultNsUri);
30    echo "isDefaultNamespace('{$defaultNsUri}'): " . ($isDefaultNsMatch ? 'true' : 'false') . " (期待値: true)" . PHP_EOL;
31
32    // ケース3: 異なる名前空間のURIを渡す
33    // ノードのデフォルト名前空間と異なるため、false が期待されます。
34    $otherNsUri = "http://example.com/other-ns";
35    $isDefaultNsMismatch = $rootElement->isDefaultNamespace($otherNsUri);
36    echo "isDefaultNamespace('{$otherNsUri}'): " . ($isDefaultNsMismatch ? 'true' : 'false') . " (期待値: false)" . PHP_EOL;
37
38    // 2. 名前空間を持たないXML要素を作成し、テスト
39    $docNoNs = new DOMDocument();
40    $noNsElement = $docNoNs->createElement('plainElement');
41    // ドキュメントツリーに追加しないと名前空間情報が正しく解決されない場合があるため、追加します。
42    $docNoNs->appendChild($noNsElement);
43
44    echo PHP_EOL . "--- 名前空間を持たない要素 ('{$noNsElement->nodeName}') ---" . PHP_EOL;
45
46    // ケース4: 名前空間を持たない要素で null を渡す
47    // このノードはデフォルト名前空間を持たないため、false が期待されます。
48    $isPlainElementDefaultNsNull = $noNsElement->isDefaultNamespace(null);
49    echo "isDefaultNamespace(null): " . ($isPlainElementDefaultNsNull ? 'true' : 'false') . " (期待値: false)" . PHP_EOL;
50
51    // ケース5: 名前空間を持たない要素でURIを渡す
52    // このノードはデフォルト名前空間を持たず、指定されたURIにも属さないため、false が期待されます。
53    $isPlainElementNsMatch = $noNsElement->isDefaultNamespace($defaultNsUri);
54    echo "isDefaultNamespace('{$defaultNsUri}'): " . ($isPlainElementNsMatch ? 'true' : 'false') . " (期待値: false)" . PHP_EOL;
55}
56
57// サンプル関数の実行
58demonstrateIsDefaultNamespace();

PHPのDom\Node::isDefaultNamespaceメソッドは、XML文書内の要素などのDOMノードが、特定の名前空間をデフォルト名前空間として持っているかどうかをチェックするために使用されます。ここで言うデフォルト名前空間とは、XML要素においてプレフィックスなしで適用される名前空間のことを指します。

このメソッドの引数にnullを渡すと、対象のノード自身がデフォルト名前空間を持っているかを判定します。例えば、<root xmlns="http://example.com/ns">のように宣言された要素はデフォルト名前空間を持っていますので、trueが返されます。一方、引数に名前空間URIを表す文字列を渡すと、そのURIがノードの現在のデフォルト名前空間と一致するかを判定します。

戻り値はbool型で、条件に合致すればtrue、そうでなければfalseが返されます。サンプルコードでは、デフォルト名前空間を持つ要素に対して正しいURIやnullを渡した場合はtrueとなり、異なるURIを渡した場合や、そもそも名前空間を持たない要素に対してはfalseが返されることが示されています。このメソッドは、XML文書の構造を解析し、要素がどの名前空間に属しているかを正確に判断する際に役立ちます。

Copy
1<?php
2
3// XML ドキュメントを作成します。
4// ここでは、デフォルト名前空間を持つ要素と持たない要素を定義し、
5// XMLドキュメント内での名前空間の「定義」と「継承」を示します。
6$xmlString = <<<XML
7<doc>
8    <root xmlns="http://www.example.com/default_ns">
9        <child1/>
10        <child2 xmlns="http://www.example.com/another_ns"/>
11        <child3/>
12    </root>
13    <noNsRoot>
14        <noNsChild/>
15    </noNsRoot>
16</doc>
17XML;
18
19// DOMDocument オブジェクトを作成し、XML文字列をロードします。
20$dom = new DOMDocument();
21$dom->loadXML($xmlString);
22
23echo "--- Dom\\Node::isDefaultNamespace メソッドのデモンストレーション ---\n\n";
24
25// 1. デフォルト名前空間を持つ要素 '<root>' のテスト
26$rootElement = $dom->getElementsByTagName('root')->item(0);
27if ($rootElement instanceof Dom\Node) {
28    echo "--- 要素 '<root>' (xmlns=\"http://www.example.com/default_ns\") ---\n";
29    $defaultNsUri = "http://www.example.com/default_ns";
30    // 指定されたURIがこのノードのデフォルト名前空間URIと一致するか確認します。
31    echo "  '{$defaultNsUri}' がデフォルト名前空間ですか？: " . ($rootElement->isDefaultNamespace($defaultNsUri) ? 'はい' : 'いいえ') . "\n"; // はい
32    echo "  'http://www.example.com/another_ns' がデフォルト名前空間ですか？: " . ($rootElement->isDefaultNamespace("http://www.example.com/another_ns") ? 'はい' : 'いいえ') . "\n"; // いいえ
33    // 引数に null を渡すと、ノードが「null名前空間」（明示的なデフォルト名前空間が定義されていない状態）に属するかをチェックします。
34    echo "  デフォルト名前空間が定義されていませんか (null)? : " . ($rootElement->isDefaultNamespace(null) ? 'はい' : 'いいえ') . "\n"; // いいえ
35    echo "\n";
36}
37
38// 2. 親からデフォルト名前空間を継承する要素 '<child1>' のテスト
39$child1Element = $dom->getElementsByTagName('child1')->item(0);
40if ($child1Element instanceof Dom\Node) {
41    echo "--- 要素 '<child1>' (親からデフォルト名前空間を継承) ---\n";
42    $inheritedNsUri = "http://www.example.com/default_ns";
43    echo "  '{$inheritedNsUri}' がデフォルト名前空間ですか？: " . ($child1Element->isDefaultNamespace($inheritedNsUri) ? 'はい' : 'いいえ') . "\n"; // はい
44    echo "  デフォルト名前空間が定義されていませんか (null)? : " . ($child1Element->isDefaultNamespace(null) ? 'はい' : 'いいえ') . "\n"; // いいえ
45    echo "\n";
46}
47
48// 3. 自身で新しいデフォルト名前空間を「定義」する要素 '<child2>' のテスト
49$child2Element = $dom->getElementsByTagName('child2')->item(0);
50if ($child2Element instanceof Dom\Node) {
51    echo "--- 要素 '<child2>' (xmlns=\"http://www.example.com/another_ns\") ---\n";
52    $newDefaultNsUri = "http://www.example.com/another_ns";
53    echo "  '{$newDefaultNsUri}' がデフォルト名前空間ですか？: " . ($child2Element->isDefaultNamespace($newDefaultNsUri) ? 'はい' : 'いいえ') . "\n"; // はい
54    echo "  親のデフォルト名前空間 ('http://www.example.com/default_ns') ですか？: " . ($child2Element->isDefaultNamespace("http://www.example.com/default_ns") ? 'はい' : 'いいえ') . "\n"; // いいえ
55    echo "  デフォルト名前空間が定義されていませんか (null)? : " . ($child2Element->isDefaultNamespace(null) ? 'はい' : 'いいえ') . "\n"; // いいえ
56    echo "\n";
57}
58
59// 4. デフォルト名前空間が定義されていない要素 '<noNsRoot>' のテスト
60$noNsRootElement = $dom->getElementsByTagName('noNsRoot')->item(0);
61if ($noNsRootElement instanceof Dom\Node) {
62    echo "--- 要素 '<noNsRoot>' (デフォルト名前空間なし) ---\n";
63    // 明示的なデフォルト名前空間が定義されていない場合、そのURIは空文字列として扱われます。
64    echo "  空文字列 '' がデフォルト名前空間ですか？: " . ($noNsRootElement->isDefaultNamespace("") ? 'はい' : 'いいえ') . "\n"; // はい
65    // null 引数は、ノードが「null名前空間」（明示的なデフォルト名前空間が設定されていない）に属するかをチェックします。
66    echo "  デフォルト名前空間が定義されていませんか (null)? : " . ($noNsRootElement->isDefaultNamespace(null) ? 'はい' : 'いいえ') . "\n"; // はい
67    echo "\n";
68}
69
70?>

PHP 8のDom\Node::isDefaultNamespaceメソッドは、XMLドキュメント内の特定のノードが、指定された名前空間URIをデフォルト名前空間として持っているかを確認するために使用されます。XMLの名前空間は、要素や属性の名前の衝突を防ぎ、データの意味を明確にするための仕組みで、通常はxmlns属性で定義されます。

このメソッドの引数$namespaceには、比較したい名前空間のURIを文字列で渡します。もし引数にnullを渡すと、そのノードが明示的なデフォルト名前空間を全く持たない、「null名前空間」に属しているかどうかを判定します。戻り値はbool型で、指定された名前空間URIがノードのデフォルト名前空間と一致すればtrue、そうでなければfalseが返されます。

サンプルコードでは、いくつかの異なる状況におけるisDefaultNamespaceの挙動が示されています。例えば、xmlns属性でデフォルト名前空間が直接定義された要素、親要素からデフォルト名前空間を「継承」した要素、そして自身で新しいデフォルト名前空間を「定義」して親の名前空間を上書きした要素について確認しています。また、デフォルト名前空間を全く持たない要素に対しても、引数に空文字列やnullを指定することで、その状態を正しく判定できることを示しており、XML要素の名前空間の定義や継承状況を正確に把握する際に役立つメソッドです。