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

Copy
1<?php
2
3/**
4 * Dom\Attr::isDefaultNamespace メソッドの動作をデモンストレーションする関数。
5 *
6 * Dom\Attr::isDefaultNamespace() は Dom\Node::isDefaultNamespace() を継承していますが、
7 * PHP の DOM 拡張では Dom\Element ノード以外（Dom\Attr ノードを含む）に対してこのメソッドを呼び出すと、
8 * 常に false を返します。これは DOM Level 3 の仕様に基づく挙動です。
9 *
10 * 属性が特定の名前空間に属しているかを確認するには、Dom\Attr::namespaceURI プロパティを使用します。
11 */
12function demonstrateDomAttrIsDefaultNamespace(): void
13{
14    // 新しい DOM ドキュメントを作成します。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    // 出力XMLを整形するために true に設定します。
17    $dom->formatOutput = true;
18
19    // ルート要素を作成し、ドキュメントに追加します。
20    $rootElement = $dom->createElement('root');
21    $dom->appendChild($rootElement);
22
23    // 1. 名前空間を持つ属性を作成します。
24    // 'http://example.org/ns1' を名前空間URIとし、'ns1:myAttribute' を属性名とします。
25    $namespaceUri = 'http://example.org/ns1';
26    $attrNameWithPrefix = 'ns1:myAttribute';
27    $attributeNodeNs = $dom->createAttributeNS($namespaceUri, $attrNameWithPrefix);
28    $attributeNodeNs->nodeValue = '値（名前空間あり）';
29    // 属性をルート要素に追加します。
30    $rootElement->setAttributeNode($attributeNodeNs);
31
32    echo "--- 名前空間を持つ属性の検証 ---\n";
33    echo "属性名: " . $attributeNodeNs->nodeName . "\n";
34    echo "属性値: " . $attributeNodeNs->nodeValue . "\n";
35    // 属性の実際の名前空間URIを表示します。
36    echo "属性の actual namespaceURI: " . ($attributeNodeNs->namespaceURI ?? 'なし') . "\n";
37
38    // Dom\Attr::isDefaultNamespace() メソッドを呼び出します。
39    // Dom\Attr オブジェクトは Dom\Element ではないため、このメソッドは常に false を返します。
40    $isDefault = $attributeNodeNs->isDefaultNamespace($namespaceUri);
41    echo "isDefaultNamespace('$namespaceUri') の結果: " . ($isDefault ? 'true' : 'false') . "\n";
42    echo "（補足: Dom\\Attr は Dom\\Element ではないため、isDefaultNamespace() は常に false を返します。）\n\n";
43
44    // 2. 名前空間を持たない通常の属性を作成します。
45    $attributeNode = $dom->createAttribute('plainAttribute');
46    $attributeNode->nodeValue = '値（名前空間なし）';
47    // 属性をルート要素に追加します。
48    $rootElement->setAttributeNode($attributeNode);
49
50    echo "--- 名前空間を持たない属性の検証 ---\n";
51    echo "属性名: " . $attributeNode->nodeName . "\n";
52    echo "属性値: " . $attributeNode->nodeValue . "\n";
53    // 属性の実際の名前空間URIを表示します。
54    echo "属性の actual namespaceURI: " . ($attributeNode->namespaceURI ?? 'なし') . "\n";
55
56    // Dom\Attr::isDefaultNamespace() メソッドを呼び出します。
57    // 名前空間を持たない属性の場合でも、Dom\Attr オブジェクトであるため常に false を返します。
58    $isDefaultPlain = $attributeNode->isDefaultNamespace('any_namespace_uri');
59    echo "isDefaultNamespace('any_namespace_uri') の結果: " . ($isDefaultPlain ? 'true' : 'false') . "\n";
60    echo "（補足: Dom\\Attr は Dom\\Element ではないため、isDefaultNamespace() は常に false を返します。）\n";
61
62    echo "\n--- 生成されたXML ---\n";
63    // 生成されたXMLを出力します。
64    echo $dom->saveXML();
65}
66
67// 上記のデモンストレーション関数を実行します。
68demonstrateDomAttrIsDefaultNamespace();

PHP 8のDom\Attr::isDefaultNamespaceメソッドは、DOM要素のデフォルト名前空間に関連する判定を行うためのものです。このメソッドは、引数$namespaceで指定された名前空間URIが、呼び出し元のノードのデフォルト名前空間であるかを真偽値（trueまたはfalse）で返します。

しかし、重要な点として、このメソッドはDOM Level 3の仕様に基づき、Dom\Element（要素ノード）に対してのみ意味を持ちます。Dom\Attr（属性ノード）に対して呼び出した場合、属性は要素のようにデフォルトの名前空間という概念を持たないため、常にfalseを返します。

サンプルコードでは、名前空間を持つ属性と持たない属性の両方でこのメソッドを試していますが、どちらのケースでも結果はfalseとなります。これは、Dom\Attrオブジェクトがこのメソッドを呼び出すと常にfalseを返すという挙動を具体的に示しています。

もし属性が特定のリネーム空間URIに属しているかを確認したい場合は、Dom\Attr::namespaceURIプロパティを使用するのが正しい方法です。このプロパティは、属性に割り当てられた名前空間URIを文字列で直接提供します。初心者の方は、属性の名前空間確認にはnamespaceURIプロパティを利用すると良いでしょう。

Copy
1<?php
2
3/**
4 * Dom\Attr::isDefaultNamespace メソッドの使用例を示します。
5 *
6 * このメソッドは、指定された名前空間URIが、属性が定義されているXML要素の
7 * デフォルト名前空間であるかを判定します。
8 * PHPの言語レベルの `namespace` キーワードとは異なり、XMLの名前空間の扱いに特化しています。
9 * XMLでは `xmlns="URI"` の形式で要素のデフォルト名前空間が定義されます。
10 *
11 * @param string $xmlString 評価するXML文字列
12 * @return void
13 */
14function demonstrateDomAttrIsDefaultNamespace(string $xmlString): void
15{
16    echo "--- 対象XMLドキュメント ---\n";
17    echo $xmlString . "\n\n";
18
19    // DOMDocumentを初期化し、XMLをロードします。
20    // loadXMLメソッドはXMLの構文エラーチェックも行います。
21    $dom = new DOMDocument();
22    if (!$dom->loadXML($xmlString)) {
23        echo "エラー: XMLのロードに失敗しました。\n";
24        return;
25    }
26
27    // --- ケース1: 要素にデフォルト名前空間が直接定義されている場合 ---
28    // 例: <element-with-default-ns xmlns="http://example.com/ns1" id="item001">
29    echo "--- ケース1: 要素にデフォルト名前空間が定義されている場合 ---\n";
30    $elementWithNs = $dom->getElementsByTagName('element-with-default-ns')->item(0);
31    if ($elementWithNs) {
32        $attrId = $elementWithNs->getAttributeNode('id');
33        if ($attrId) {
34            echo "  対象属性: '{$attrId->name}' (要素: {$elementWithNs->tagName})\n";
35            echo "    属性のローカル名: '{$attrId->localName}'\n";
36            echo "    属性の名前空間URI: " . ($attrId->namespaceURI ?? 'なし') . " (この属性自体は名前空間を持っていません)\n";
37
38            $expectedNs1 = 'http://example.com/ns1';
39            $isDefault1 = $attrId->isDefaultNamespace($expectedNs1);
40            echo "    検証: 要素のデフォルト名前空間 ('{$expectedNs1}') と一致するか？ " . ($isDefault1 ? 'はい' : 'いいえ') . "\n";
41
42            $unexpectedNs = 'http://example.com/ns_other';
43            $isDefault2 = $attrId->isDefaultNamespace($unexpectedNs);
44            echo "    検証: 異なる名前空間 ('{$unexpectedNs}') と一致するか？ " . ($isDefault2 ? 'はい' : 'いいえ') . "\n";
45            echo "\n";
46        }
47    }
48
49    // --- ケース2: 要素にデフォルト名前空間が定義されていない場合 ---
50    // 例: <element-no-ns value="data123"> (親要素から継承せず、自身も定義しない)
51    echo "--- ケース2: 要素にデフォルト名前空間が定義されていない場合 ---\n";
52    $elementNoNs = $dom->getElementsByTagName('element-no-ns')->item(0);
53    if ($elementNoNs) {
54        $attrValue = $elementNoNs->getAttributeNode('value');
55        if ($attrValue) {
56            echo "  対象属性: '{$attrValue->name}' (要素: {$elementNoNs->tagName})\n";
57            echo "    属性のローカル名: '{$attrValue->localName}'\n";
58            echo "    属性の名前空間URI: " . ($attrValue->namespaceURI ?? 'なし') . " (この属性自体は名前空間を持っていません)\n";
59
60            // この要素はデフォルト名前空間を持たないため、いかなるURIとも一致しません。
61            $anyNs = 'http://example.com/ns_any';
62            $isDefault3 = $attrValue->isDefaultNamespace($anyNs);
63            echo "    検証: いずれかの名前空間 ('{$anyNs}') と一致するか？ " . ($isDefault3 ? 'はい' : 'いいえ') . "\n";
64
65            // 空文字列は「名前空間なし」を意味する場合もありますが、
66            // isDefaultNamespaceでは特定のURIとの比較を行うため、
67            // デフォルト名前空間が定義されていない場合は 'false' となります。
68            $isDefaultEmpty = $attrValue->isDefaultNamespace('');
69            echo "    検証: 空の名前空間URI ('') と一致するか？ " . ($isDefaultEmpty ? 'はい' : 'いいえ') . "\n";
70            echo "\n";
71        }
72    }
73
74    // --- ケース3: 要素が親要素からデフォルト名前空間を継承している場合 ---
75    // 例: <root xmlns="http://example.com/global-ns"> ... <child-element inherited-attr="test"/>
76    echo "--- ケース3: 要素が親からデフォルト名前空間を継承している場合 ---\n";
77    $childElement = $dom->getElementsByTagName('child-element')->item(0);
78    if ($childElement) {
79        $attrInherited = $childElement->getAttributeNode('inherited-attr');
80        if ($attrInherited) {
81            echo "  対象属性: '{$attrInherited->name}' (要素: {$childElement->tagName})\n";
82            echo "    属性のローカル名: '{$attrInherited->localName}'\n";
83            echo "    属性の名前空間URI: " . ($attrInherited->namespaceURI ?? 'なし') . " (この属性自体は名前空間を持っていません)\n";
84
85            $inheritedNs = 'http://example.com/global-ns';
86            $isDefault4 = $attrInherited->isDefaultNamespace($inheritedNs);
87            echo "    検証: 親要素から継承したデフォルト名前空間 ('{$inheritedNs}') と一致するか？ " . ($isDefault4 ? 'はい' : 'いいえ') . "\n";
88            echo "\n";
89        }
90    }
91}
92
93// サンプルXMLの定義
94// XMLの名前空間の定義 (xmlns="...") を含みます。
95$sampleXml = <<<XML
96<?xml version="1.0" encoding="UTF-8"?>
97<root xmlns="http://example.com/global-ns">
98    <element-with-default-ns xmlns="http://example.com/ns1" id="item001">
99        <sub-element />
100    </element-with-default-ns>
101    <element-no-ns value="data123">
102        <sub-element />
103    </element-no-ns>
104    <child-element inherited-attr="test-value"/>
105</root>
106XML;
107
108// 関数を実行してDom\Attr::isDefaultNamespaceの動作を確認します。
109demonstrateDomAttrIsDefaultNamespace($sampleXml);
110

Dom\Attr::isDefaultNamespaceメソッドは、XML文書内で使用される属性が、所属するXML要素のデフォルト名前空間と、指定された名前空間URIが一致するかどうかを判定します。このメソッドはPHP言語のnamespaceキーワードとは異なり、XMLの名前空間の概念に特化しています。

このメソッドはDom\Attrオブジェクトから呼び出され、比較したい名前空間URIをstring $namespace型の引数として受け取ります。戻り値は、指定された名前空間URIが要素のデフォルト名前空間と一致すればtrue、そうでなければfalseを返すbool型です。

サンプルコードでは、まずXML文字列をDOMDocumentにロードし、複数のシナリオでisDefaultNamespaceの動作を確認しています。例えば、<element-with-default-ns xmlns="http://example.com/ns1" id="item001">のように要素に直接デフォルト名前空間が定義されている場合、id属性からisDefaultNamespace("http://example.com/ns1")を呼び出すとtrueを返します。要素にデフォルト名前空間が定義されていない場合は常にfalseとなります。また、要素が親要素からデフォルト名前空間を継承している場合も、その継承された名前空間URIに対して正しくtrueを返します。このメソッドは、属性自体が名前空間を持つかどうかではなく、属性が所属するXML要素のデフォルト名前空間を基に判定を行います。