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

Copy
1<?php
2
3/**
4 * DOMAttr::isDefaultNamespace メソッドの使用例を示します。
5 *
6 * このメソッドは、DOMAttr オブジェクトが特定の名前空間URIのデフォルト名前空間に属するかどうかをテストします。
7 * XMLの仕様では、属性は親要素のデフォルト名前空間を継承しません。
8 * また、プレフィックスを持たない属性は名前空間を持たないと定義されています。
9 * そのため、DOMAttr::isDefaultNamespace メソッドは通常、false を返します。
10 * このサンプルコードでは、その挙動を具体的に示します。
11 */
12function demonstrateDomAttrIsDefaultNamespace(): void
13{
14    // DOMDocument オブジェクトを作成し、XMLを整形して出力するように設定します。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    $dom->preserveWhiteSpace = false; // 不要な空白ノードを削除
17    $dom->formatOutput = true;      // 整形されたXMLを出力
18
19    // テスト用のXML文字列を定義します。
20    // <root>要素はデフォルト名前空間とプレフィックス付き名前空間を定義しています。
21    // <element>要素には、プレフィックス付き属性と、プレフィックスなしの属性が含まれます。
22    $xmlString = <<<XML
23<root xmlns="http://example.com/default_ns" xmlns:my_pref="http://example.com/my_pref_ns">
24    <element my_pref:attribute="value1" simple-attribute="value2" />
25</root>
26XML;
27    // XML文字列をDOMDocumentにロードします。
28    if (!$dom->loadXML($xmlString)) {
29        echo "XMLのロードに失敗しました。\n";
30        return;
31    }
32
33    // 'element' という名前の要素を取得します。
34    $elements = $dom->getElementsByTagName('element');
35    if ($elements->count() === 0) {
36        echo "要素 'element' が見つかりませんでした。\n";
37        return;
38    }
39    $element = $elements->item(0);
40
41    echo "--- プレフィックス付き属性のテスト --- \n";
42    // 'my_pref:attribute' 属性を取得します。
43    // この属性は 'my_pref' というプレフィックスを持ち、'http://example.com/my_pref_ns' 名前空間に属します。
44    $prefixedAttr = $element->getAttributeNode('my_pref:attribute');
45    if ($prefixedAttr !== null) {
46        echo "属性名: '{$prefixedAttr->name}'\n";
47        echo "  - namespaceURI: " . ($prefixedAttr->namespaceURI ?? 'null') . "\n";
48        echo "  - prefix: " . ($prefixedAttr->prefix ?? 'null') . "\n";
49
50        // この属性がその名前空間 ('http://example.com/my_pref_ns') のデフォルト名前空間であるかをテストします。
51        // 結果は false となります。なぜなら、属性にプレフィックスがあるため、デフォルト名前空間とは見なされません。
52        $isDefaultPrefixed = $prefixedAttr->isDefaultNamespace('http://example.com/my_pref_ns');
53        echo "  - isDefaultNamespace('http://example.com/my_pref_ns'): " . var_export($isDefaultPrefixed, true) . "\n";
54    }
55
56    echo "\n--- プレフィックスなし属性のテスト --- \n";
57    // 'simple-attribute' 属性を取得します。
58    // この属性はプレフィックスを持たないため、XMLの仕様上、名前空間を持っていません (namespaceURI は null)。
59    $simpleAttr = $element->getAttributeNode('simple-attribute');
60    if ($simpleAttr !== null) {
61        echo "属性名: '{$simpleAttr->name}'\n";
62        echo "  - namespaceURI: " . ($simpleAttr->namespaceURI ?? 'null') . "\n";
63        echo "  - prefix: " . ($simpleAttr->prefix ?? 'null') . "\n";
64
65        // 親要素のデフォルト名前空間 ('http://example.com/default_ns') と比較します。
66        // 結果は false となります。なぜなら、プレフィックスを持たない属性の namespaceURI は null であり、
67        // いかなる名前空間URIとも一致しないためです。
68        $isDefaultSimple = $simpleAttr->isDefaultNamespace('http://example.com/default_ns');
69        echo "  - isDefaultNamespace('http://example.com/default_ns'): " . var_export($isDefaultSimple, true) . "\n";
70
71        // 空の文字列を名前空間URIとして指定した場合でも、namespaceURI が null であるため false となります。
72        $isDefaultEmpty = $simpleAttr->isDefaultNamespace('');
73        echo "  - isDefaultNamespace(''): " . var_export($isDefaultEmpty, true) . "\n";
74    }
75
76    echo "\n--- まとめ ---\n";
77    echo "DOMAttr::isDefaultNamespace() メソッドは、その属性がプレフィックスを持たず、\n";
78    echo "かつその attributes->namespaceURI プロパティが指定された名前空間URIと一致する場合にのみ true を返します。\n";
79    echo "しかし、XMLの仕様では、プレフィックスを持たない属性は名前空間を持たず (namespaceURI が null)、\n";
80    echo "プレフィックスを持つ属性は、その時点でデフォルト名前空間ではないと判断されます。\n";
81    echo "したがって、このメソッドは DOMAttr オブジェクトに対して常に false を返すのが一般的であり、\n";
82    echo "実用上、DOMAttr::isDefaultNamespace() が true を返すことは非常に稀です。\n";
83}
84
85// 定義した関数を実行して、DOMAttr::isDefaultNamespace の動作を確認します。
86demonstrateDomAttrIsDefaultNamespace();
87

DOMAttr::isDefaultNamespace メソッドは、XMLドキュメント内の属性（DOMAttrオブジェクト）が、引数 $namespace で指定された名前空間URIの「デフォルト名前空間」に属するかどうかを真偽値（bool）で判定します。引数 $namespace には、比較したい名前空間URIを文字列として渡します。

XMLの仕様では、属性に関する名前空間の扱いに特別なルールがあります。属性は親要素のデフォルト名前空間を継承せず、また、プレフィックスを持たない属性は名前空間を持たないと定義されており、その namespaceURI プロパティは null となります。

これらの仕様により、DOMAttr::isDefaultNamespace メソッドは、通常は false を返します。例えば、プレフィックスを持つ属性は、そのプレフィックスによって明示的に名前空間が指定されているためデフォルト名前空間ではありません。また、プレフィックスを持たない属性は、そもそも名前空間を持たないため、指定された名前空間URIが何であってもデフォルト名前空間とは見なされません。

このサンプルコードでは、プレフィックス付きの属性と、プレフィックスなしの属性のそれぞれに対して DOMAttr::isDefaultNamespace メソッドを適用し、その両方で結果が false になる具体的な挙動を示しています。したがって、このメソッドが true を返すケースは実用上極めて稀であると理解しておくと良いでしょう。

Copy
1<?php
2
3/**
4 * DOMAttr::isDefaultNamespace メソッドの使用例を示します。
5 *
6 * この関数は、XML ドキュメントから特定の属性ノードを取得し、
7 * その属性が指定された名前空間の「デフォルト名前空間」であるかどうかを
8 * isDefaultNamespace メソッドを用いて判定する方法をデモンストレーションします。
9 *
10 * XMLの名前空間について:
11 * - 'xmlns="URI"' は、要素のデフォルト名前空間を定義します。
12 * - 'xmlns:prefix="URI"' は、プレフィックスとURIを関連付けます。
13 * - 属性は通常、デフォルト名前空間に属しません。ただし、'xmlns'属性自体は、
14 *   それが定義するURIのデフォルト名前空間であると見なされる特殊なケースです。
15 * - プレフィックス付き属性 (例: 'prefix:attr') は、そのプレフィックスに関連付けられた
16 *   名前空間に属しますが、要素のデフォルト名前空間ではありません。
17 * - プレフィックスのない属性 (例: 'attr') は、通常、名前空間に属しません。
18 */
19function demonstrateDomAttrIsDefaultNamespace(): void
20{
21    // XML文字列を定義します。
22    // ここで `xmlns` 属性を使ってXMLの名前空間を定義しています。
23    $xmlString = <<<'XML'
24<root xmlns="http://example.com/default_ns"
25      xmlns:prefix="http://example.com/prefix_ns"
26      plainAttr="This is a plain attribute"
27      prefix:myAttr="This is a prefixed attribute">
28    <item/>
29</root>
30XML;
31
32    echo "--- XML ドキュメント ---\n";
33    echo $xmlString . "\n\n";
34
35    // DOMDocument オブジェクトを作成し、XMLをロードします。
36    $dom = new DOMDocument();
37    // XMLをロードする際、エラーが発生しないように設定します。
38    $dom->loadXML($xmlString, LIBXML_NOERROR | LIBXML_NOWARNING);
39
40    // ドキュメントのルート要素を取得します。
41    $documentElement = $dom->documentElement;
42
43    echo "--- DOMAttr::isDefaultNamespace の検証 ---\n\n";
44
45    // ケース1: デフォルト名前空間を定義する `xmlns` 属性の確認
46    // `xmlns` 属性自体は、それが定義する名前空間のデフォルト名前空間であると判断されます。
47    $attrName1 = 'xmlns';
48    $targetNamespace1 = 'http://example.com/default_ns';
49    $attr1 = $documentElement->attributes->getNamedItem($attrName1);
50    if ($attr1) {
51        $isDefault1 = $attr1->isDefaultNamespace($targetNamespace1);
52        echo "属性 '{$attr1->name}' (値: '{$attr1->value}') が\n";
53        echo "名前空間 '{$targetNamespace1}' のデフォルト名前空間か？: ";
54        echo ($isDefault1 ? "true" : "false") . " (期待値: true)\n\n";
55    }
56
57    // ケース2: `xmlns` 属性に対して異なるURIで確認
58    // 属性が定義しているURIと異なるため、`false` を返します。
59    $targetNamespace2 = 'http://example.com/another_ns';
60    if ($attr1) {
61        $isDefault2 = $attr1->isDefaultNamespace($targetNamespace2);
62        echo "属性 '{$attr1->name}' が\n";
63        echo "名前空間 '{$targetNamespace2}' のデフォルト名前空間か？: ";
64        echo ($isDefault2 ? "true" : "false") . " (期待値: false)\n\n";
65    }
66
67    // ケース3: プレフィックス付き名前空間を持つ属性の確認
68    // `prefix:myAttr` は `http://example.com/prefix_ns` に属しますが、
69    // 要素のデフォルト名前空間ではないため、`false` を返します。
70    $attrName3 = 'prefix:myAttr';
71    $targetNamespace3 = 'http://example.com/prefix_ns';
72    $attr3 = $documentElement->attributes->getNamedItem($attrName3);
73    if ($attr3) {
74        $isDefault3 = $attr3->isDefaultNamespace($targetNamespace3);
75        echo "属性 '{$attr3->name}' (値: '{$attr3->value}') が\n";
76        echo "名前空間 '{$targetNamespace3}' のデフォルト名前空間か？: ";
77        echo ($isDefault3 ? "true" : "false") . " (期待値: false)\n\n";
78    }
79
80    // ケース4: 名前空間を持たない属性の確認
81    // `plainAttr` は名前空間を持たないため、どのURIに対しても `false` を返します。
82    $attrName4 = 'plainAttr';
83    $targetNamespace4 = 'http://example.com/default_ns'; // 任意のURI
84    $attr4 = $documentElement->attributes->getNamedItem($attrName4);
85    if ($attr4) {
86        $isDefault4 = $attr4->isDefaultNamespace($targetNamespace4);
87        echo "属性 '{$attr4->name}' (値: '{$attr4->value}') が\n";
88        echo "名前空間 '{$targetNamespace4}' のデフォルト名前空間か？: ";
89        echo ($isDefault4 ? "true" : "false") . " (期待値: false)\n\n";
90    }
91}
92
93// 関数を実行してデモンストレーションを開始します。
94demonstrateDomAttrIsDefaultNamespace();
95

PHP 8で提供されるDOMAttr::isDefaultNamespaceメソッドは、XMLドキュメント内の属性ノードが、引数で指定された名前空間の「デフォルト名前空間」であるかを真偽値で判定するものです。

引数$namespaceには、確認したい名前空間のURI（Uniform Resource Identifier）を文字列で指定します。メソッドは、対象の属性がこのURIで定義されるデフォルト名前空間に属する場合にtrueを、そうでない場合にfalseを戻り値として返します。

XMLの名前空間において、要素のデフォルト名前空間は通常、xmlns="http://example.com/uri"の形式で定義されます。このメソッドを使う上で特に理解すべき点は、xmlns属性自体が、それが定義するURIのデフォルト名前空間であると見なされるという特殊な挙動です。しかし、prefix:attrのようなプレフィックス付き属性や、plainAttrのような名前空間を持たない通常の属性は、要素のデフォルト名前空間とは異なるため、このメソッドでは通常falseを返します。

サンプルコードでは、XMLドキュメント内のxmlns属性と他の種類の属性を対象に、それぞれが指定された名前空間のデフォルト名前空間であるかを確認しています。これにより、xmlns属性が自身の定義する名前空間に対してtrueを返す一方で、異なるURIや他の一般的な属性に対してはfalseを返すという具体的な挙動を理解できます。これは、PHPでXMLの名前空間を扱う上で重要な概念の一つです。