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

Copy
1<?php
2
3// Dom\Element::isDefaultNamespace メソッドの動作を確認するサンプルコードです。
4// このメソッドは、DOM要素が指定された名前空間URIをデフォルトの名前空間として使用しているかチェックします。
5
6// 1. DOMDocument オブジェクトを初期化します。
7//    XMLドキュメントを作成および操作するために必要です。
8$dom = new DOMDocument('1.0', 'UTF-8');
9$dom->formatOutput = true; // 出力されるXMLを見やすく整形します。
10
11// 2. デフォルト名前空間を持つルート要素を作成します。
12//    createElementNS() を使用し、最初の引数で名前空間URI、2番目の引数で要素名を指定します。
13//    接頭辞を指定しないことで、この名前空間がデフォルトとして扱われます。
14$defaultNamespaceUri = 'http://example.com/ns/app';
15$rootElement = $dom->createElementNS($defaultNamespaceUri, 'root');
16$dom->appendChild($rootElement);
17
18// 3. デフォルト名前空間を持つ子要素を作成します。
19//    親要素と同じデフォルト名前空間に属するように作成します。
20$itemElement = $dom->createElementNS($defaultNamespaceUri, 'item');
21$rootElement->appendChild($itemElement);
22
23// Dom\Element は DOMElement の基底クラスです。
24// ここでは $itemElement が Dom\Element のインスタンスとして扱われます。
25$itemDomElement = $itemElement;
26
27echo "--- Dom\\Element::isDefaultNamespace の動作確認 ---\n\n";
28
29// --- デフォルト名前空間が設定されている要素 ($itemDomElement) の確認 ---
30echo "要素 '<item>' (デフォルト名前空間: '{$defaultNamespaceUri}') の確認:\n";
31
32// 3.1. 正しいデフォルト名前空間URIでチェックします。
33if ($itemDomElement->isDefaultNamespace($defaultNamespaceUri)) {
34    echo "  - '{$defaultNamespaceUri}' はデフォルト名前空間です。(期待通り: true)\n";
35} else {
36    echo "  - '{$defaultNamespaceUri}' はデフォルト名前空間ではありません。(期待通り: false)\n";
37}
38
39// 3.2. 異なる名前空間URIでチェックします。
40$otherNamespaceUri = 'http://example.com/ns/other';
41if ($itemDomElement->isDefaultNamespace($otherNamespaceUri)) {
42    echo "  - '{$otherNamespaceUri}' はデフォルト名前空間です。(期待通り: false)\n";
43} else {
44    echo "  - '{$otherNamespaceUri}' はデフォルト名前空間ではありません。(期待通り: true)\n";
45}
46
47// 3.3. 引数に null を指定してチェックします。
48//      null を指定すると、「何らかの」デフォルト名前空間が設定されているかをチェックします。
49if ($itemDomElement->isDefaultNamespace(null)) {
50    echo "  - null を指定: 何らかのデフォルト名前空間が設定されています。(期待通り: true)\n";
51    // 実際に設定されているURIを確認する場合は lookupNamespaceURI(null) を使用します。
52    echo "    (実際のデフォルト名前空間URI: '{$itemDomElement->lookupNamespaceURI(null)}')\n";
53} else {
54    echo "  - null を指定: デフォルト名前空間は設定されていません。(期待通り: false)\n";
55}
56
57// 3.4. 引数に空文字列 '' を指定してチェックします。
58//      これは、「デフォルト名前空間が空文字列であるか？」をチェックします。
59//      現在の要素には有効なURIが設定されているため、false を返します。
60if ($itemDomElement->isDefaultNamespace('')) {
61    echo "  - '' を指定: デフォルト名前空間は空文字列です。(期待通り: false)\n";
62} else {
63    echo "  - '' を指定: デフォルト名前空間は空文字列ではありません。(期待通り: true)\n";
64}
65
66echo "\n";
67
68// --- デフォルト名前空間が設定されていない要素 ($noNamespaceElement) の確認 ---
69
70// 4. 名前空間を持たない要素を作成します。
71//    createElement() を使うと、要素は名前空間を持たない（XMLでは「名前空間なし」となります）。
72$noNamespaceElement = $dom->createElement('noNamespaceItem');
73$rootElement->appendChild($noNamespaceElement);
74$noNamespaceDomElement = $noNamespaceElement;
75
76echo "要素 '<noNamespaceItem>' (デフォルト名前空間: なし) の確認:\n";
77
78// 4.1. 引数に null を指定してチェックします。
79//      この要素は有効なデフォルト名前空間を持たないため、false を返します。
80if ($noNamespaceDomElement->isDefaultNamespace(null)) {
81    echo "  - null を指定: 何らかのデフォルト名前空間が設定されています。(期待通り: false)\n";
82} else {
83    echo "  - null を指定: デフォルト名前空間は設定されていません。(期待通り: true)\n";
84}
85
86// 4.2. 引数に空文字列 '' を指定してチェックします。
87//      createElement() で作成された名前空間を持たない要素は、そのデフォルト名前空間が
88//      空文字列として扱われるため、isDefaultNamespace('') は true を返します。
89if ($noNamespaceDomElement->isDefaultNamespace('')) {
90    echo "  - '' を指定: デフォルト名前空間は空文字列です。(期待通り: true)\n";
91    // 名前空間なしの要素に対して lookupNamespaceURI(null) は null を返します。
92    echo "    (lookupNamespaceURI(null): " . var_export($noNamespaceDomElement->lookupNamespaceURI(null), true) . ")\n";
93} else {
94    echo "  - '' を指定: デフォルト名前空間は空文字列ではありません。(期待通り: false)\n";
95}

PHP 8のDom\Element::isDefaultNamespaceメソッドは、XMLのDOM要素が指定された名前空間URIをデフォルトの名前空間として使っているかを判定するメソッドです。結果をtrueまたはfalseで返します。

引数$namespaceには、確認したい名前空間URIを文字列で指定します。要素のデフォルト名前空間URIと引数が一致すればtrueを返します。 引数にnullを指定した場合、その要素に何らかのデフォルト名前空間が設定されていればtrueとなります。例えば、createElementNS()で作成された、デフォルト名前空間を持つ要素であればtrueです。 一方、引数に空文字列''を指定すると、デフォルト名前空間が「空文字列」であるかをチェックします。createElement()で作成された名前空間を持たない要素は、デフォルト名前空間が空文字列として扱われるため、isDefaultNamespace('')を呼ぶとtrueとなります。

サンプルコードでは、まずcreateElementNS()で特定のデフォルト名前空間を持つ要素を作成し、正しいURIやnullでisDefaultNamespace()を呼び出すとtrueを返すことを示しています。異なるURIや空文字列で呼び出した場合はfalseとなります。 また、createElement()で名前空間を持たない要素を作成した際には、isDefaultNamespace(null)ではfalse、isDefaultNamespace('')ではtrueを返すという挙動も確認できます。このメソッドは、XML要素のデフォルト名前空間の状態を正確に判断する際に役立ちます。

Copy
1<?php
2
3/**
4 * Dom\Element::isDefaultNamespace メソッドの動作をデモンストレーションします。
5 *
6 * この関数は、XMLドキュメントにおける「デフォルト名前空間 (xmlns="URI")」の概念を説明し、
7 * Dom\Element::isDefaultNamespace メソッドが、ある要素のデフォルト名前空間が
8 * 指定された名前空間URIと一致するかどうかをどのように判定するかを示します。
9 *
10 * システムエンジニアを目指す初心者の方にも理解しやすいように、
11 * XMLの名前空間の定義（キーワード「php define namespace」が指すXML側の名前空間定義）と
12 * その判定ロジックを複数のケースで具体的に示します。
13 */
14function demonstrateDomIsDefaultNamespace(): void
15{
16    echo "--- Dom\\Element::isDefaultNamespace のデモンストレーション ---\n\n";
17
18    // 1. Dom\Document の作成
19    //    XMLドキュメントを作成するための基本オブジェクトです。
20    $dom = new Dom\Document('1.0', 'UTF-8');
21    $dom->formatOutput = true; // 生成されるXMLを見やすく整形します
22
23    // 2. デフォルト名前空間を持つルート要素の作成
24    //    createElementNS() の第1引数で名前空間URI、第2引数で要素名を指定します。
25    //    要素名にプレフィックスが含まれていない場合、指定されたURIがその要素のデフォルト名前空間となります。
26    //    これは `<root xmlns="http://example.com/defaultns">` に相当します。
27    $defaultNsUri = 'http://example.com/ns/default';
28    $rootElement = $dom->createElementNS($defaultNsUri, 'root');
29    $dom->appendChild($rootElement);
30
31    // 3. ルート要素の子として、デフォルト名前空間を継承する要素を作成
32    //    親要素がデフォルト名前空間を持っていれば、子要素も明示的に名前空間を指定しない限りそれを継承します。
33    $childElement = $dom->createElementNS($defaultNsUri, 'child');
34    $rootElement->appendChild($childElement);
35
36    // 4. プレフィックス付き名前空間に属する要素を作成
37    //    要素名に 'other:item' のようにプレフィックスが含まれる場合、
38    //    その要素はデフォルト名前空間ではなく、プレフィックスに紐づく名前空間に属します。
39    //    この場合、その要素自体はデフォルト名前空間を持ちません。
40    $otherNsUri = 'http://example.com/ns/other';
41    $otherPrefix = 'other';
42    $prefixedElement = $dom->createElementNS($otherNsUri, $otherPrefix . ':item');
43
44    //    XMLでこのプレフィックスを定義するために、xmlns:other 属性をルート要素に追加します。
45    $rootElement->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:' . $otherPrefix, $otherNsUri);
46    $rootElement->appendChild($prefixedElement);
47
48    // 5. 名前空間を持たない通常の要素を作成
49    //    createElement() を使用すると、どの名前空間にも属さない要素を作成できます。
50    $plainElement = $dom->createElement('plain-tag');
51    $rootElement->appendChild($plainElement);
52
53    // 生成されたXMLの確認
54    // isDefaultNamespace の結果を理解するために、実際のXML構造を確認しましょう。
55    echo "--- 生成されたXMLドキュメント ---\n";
56    echo htmlspecialchars($dom->saveXML()) . "\n\n"; // HTMLエンティティに変換して表示し、安全性を確保
57
58    // --- Dom\Element::isDefaultNamespace の動作確認 ---
59    echo "--- Dom\\Element::isDefaultNamespace の結果 ---\n";
60
61    // ケース1: デフォルト名前空間を持つ要素 ('root')
62    echo "\n[要素: 'root'] (デフォルト名前空間: '{$defaultNsUri}')\n";
63    echo "  指定URI '{$defaultNsUri}' がデフォルト名前空間か？ : ";
64    var_dump($rootElement->isDefaultNamespace($defaultNsUri)); // 期待値: true (この要素のデフォルトNSと一致)
65    echo "  指定URI '{$otherNsUri}' がデフォルト名前空間か？ : ";
66    var_dump($rootElement->isDefaultNamespace($otherNsUri));   // 期待値: false (別のNSのため)
67    echo "  null (名前空間なし) がデフォルト名前空間か？ : ";
68    var_dump($rootElement->isDefaultNamespace(null));          // 期待値: false (デフォルトNSがあるため、nullとは一致しない)
69
70    // ケース2: デフォルト名前空間を親から継承する要素 ('child')
71    echo "\n[要素: 'child'] (親要素からデフォルト名前空間 '{$defaultNsUri}' を継承)\n";
72    echo "  指定URI '{$defaultNsUri}' がデフォルト名前空間か？ : ";
73    var_dump($childElement->isDefaultNamespace($defaultNsUri)); // 期待値: true (継承したデフォルトNSと一致)
74
75    // ケース3: プレフィックス付き名前空間に属する要素 ('other:item')
76    //          この要素はデフォルト名前空間を持ちません。
77    echo "\n[要素: '{$otherPrefix}:item'] (名前空間: '{$otherNsUri}', ただしデフォルト名前空間ではない)\n";
78    echo "  指定URI '{$otherNsUri}' (自身の名前空間) がデフォルト名前空間か？ : ";
79    var_dump($prefixedElement->isDefaultNamespace($otherNsUri)); // 期待値: false (プレフィックス付きはデフォルトNSではない)
80    echo "  指定URI '{$defaultNsUri}' がデフォルト名前空間か？ : ";
81    var_dump($prefixedElement->isDefaultNamespace($defaultNsUri)); // 期待値: false (関係ないNSのため)
82
83    // ケース4: 名前空間を持たない要素 ('plain-tag')
84    //          この要素はどの名前空間にも属していません。
85    echo "\n[要素: 'plain-tag'] (名前空間なし)\n";
86    echo "  任意のURI '{$defaultNsUri}' がデフォルト名前空間か？ : ";
87    var_dump($plainElement->isDefaultNamespace($defaultNsUri)); // 期待値: false (名前空間自体がないため)
88    echo "  null (名前空間なし) がデフォルト名前空間か？ : ";
89    var_dump($plainElement->isDefaultNamespace(null));          // 期待値: false (名前空間自体がないため、nullとも一致しない)
90}
91
92// デモンストレーション関数の実行
93demonstrateDomIsDefaultNamespace();
94
95?>

PHP 8のDom\Element::isDefaultNamespaceメソッドは、特定のXML要素が指定されたデフォルト名前空間に属しているかどうかを判定するために利用されます。このメソッドは引数として、比較したい名前空間URIを文字列（?string $namespace）で受け取ります。要素のデフォルト名前空間が引数で指定されたURIと一致する場合、真（bool true）を返し、そうでなければ偽（bool false）を返します。引数にnullを指定した場合でも、その要素にデフォルト名前空間が存在しない場合はfalseとなります。

XMLにおける「デフォルト名前空間」とは、xmlns="URI"形式で定義され、その要素自身と、プレフィックスなしで定義されたすべての子孫要素に適用される名前空間を指します。例えばサンプルコードでは、ルート要素がhttp://example.com/ns/defaultをデフォルト名前空間として定義し、その子要素もこれを継承しているため、これらの要素に対してメソッドを呼び出すとtrueが返されます。

しかし、xmlns:prefix="URI"のようにプレフィックス付きで定義された名前空間に属する要素（例: other:item）や、名前空間が全く定義されていない要素（例: plain-tag）の場合、自身の名前空間URIを引数に指定しても、isDefaultNamespaceメソッドからはfalseが返されます。これは、このメソッドがXMLの「デフォルト名前空間」の厳密な定義に基づいて判定を行うためです。このメソッドを理解することで、XMLドキュメントにおける要素の名前空間構造を正確に解析し、目的の要素を効率的に特定するのに役立ちます。