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

Copy
1<?php
2
3/**
4 * Dom\Text::isDefaultNamespace() メソッドの動作を示すサンプルコードです。
5 *
6 * このメソッドは、指定されたテキストノードがデフォルト名前空間に属しているか、
7 * または指定された名前空間URIがそのノードのデフォルト名前空間であるかを判定します。
8 *
9 * @return void
10 */
11function demonstrateDefaultNamespaceCheck(): void
12{
13    // DOMDocumentオブジェクトを作成し、XMLをロードするための準備
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    // XML整形時の空白ノードを無視する設定
16    $dom->preserveWhiteSpace = false;
17    // 整形されたXMLを出力する設定（デバッグ時に便利）
18    $dom->formatOutput = true;
19
20    // テスト用のXML文字列を定義します。
21    // - <root>要素は "http://example.com/default-ns" をデフォルト名前空間として宣言
22    // - <item>要素内のテキストノードはこのデフォルト名前空間を継承
23    // - <no_ns_item>要素は xmlns="" で明示的に名前空間を解除
24    // - <another_item>要素内のテキストノードは <root> のデフォルト名前空間を継承
25    $xmlString = <<<XML
26    <root xmlns="http://example.com/default-ns">
27      <item>このテキストはデフォルト名前空間に属します。</item>
28      <no_ns_item xmlns="">このテキストは名前空間を持ちません。</no_ns_item>
29      <another_item>これもデフォルト名前空間に属するテキストです。</another_item>
30    </root>
31    XML;
32
33    // XML文字列をDOMDocumentにロード
34    if (!$dom->loadXML($xmlString)) {
35        echo "XMLのロードに失敗しました。\n";
36        return;
37    }
38
39    // XPathを使って、特定のテキストノードを効率的に取得
40    $xpath = new DOMXPath($dom);
41
42    // --- ケース1: デフォルト名前空間に属するテキストノード ---
43    // <item>要素内のテキストノードを取得します。
44    // 親要素のデフォルト名前空間 "http://example.com/default-ns" を継承します。
45    $itemTextNode = $xpath->query('//item/text()')->item(0);
46
47    if ($itemTextNode instanceof Dom\Text) {
48        echo "--- <item>要素内のテキストノードの確認 ---\n";
49        echo "ノード値: \"" . $itemTextNode->nodeValue . "\"\n";
50
51        // 引数なしの場合: このノードが何らかのデフォルト名前空間に属していれば true を返します。
52        // （名前空間URIが空文字列ではない場合）
53        // 期待値: true (http://example.com/default-ns に属するため)
54        echo "isDefaultNamespace() (引数なし): " . ($itemTextNode->isDefaultNamespace() ? 'true' : 'false') . "\n";
55
56        // 特定の名前空間URIを指定した場合: そのURIがこのノードのデフォルト名前空間であれば true を返します。
57        // 期待値: true (一致するため)
58        echo "isDefaultNamespace('http://example.com/default-ns'): " . ($itemTextNode->isDefaultNamespace('http://example.com/default-ns') ? 'true' : 'false') . "\n";
59
60        // 異なる名前空間URIを指定した場合
61        // 期待値: false (一致しないため)
62        echo "isDefaultNamespace('http://example.com/another-ns'): " . ($itemTextNode->isDefaultNamespace('http://example.com/another-ns') ? 'true' : 'false') . "\n";
63
64        // 空文字列（名前空間なし）を指定した場合
65        // 期待値: false (デフォルト名前空間を持つため)
66        echo "isDefaultNamespace(''): " . ($itemTextNode->isDefaultNamespace('') ? 'true' : 'false') . "\n";
67        echo "\n";
68    } else {
69        echo "<item>要素内のテキストノードが見つかりませんでした。\n\n";
70    }
71
72    // --- ケース2: 明示的に名前空間が解除されたテキストノード ---
73    // <no_ns_item>要素内のテキストノードを取得します。
74    // xmlns="" 属性により、名前空間を持たない（空文字列の名前空間URI）とされます。
75    $noNsItemTextNode = $xpath->query('//no_ns_item/text()')->item(0);
76
77    if ($noNsItemTextNode instanceof Dom\Text) {
78        echo "--- <no_ns_item>要素内のテキストノードの確認 ---\n";
79        echo "ノード値: \"" . $noNsItemTextNode->nodeValue . "\"\n";
80
81        // 引数なしの場合: このノードが何らかのデフォルト名前空間に属しているか。
82        // 期待値: false (名前空間が解除されているため、デフォルト名前空間は空文字列であり、何らかの名前空間ではない)
83        echo "isDefaultNamespace() (引数なし): " . ($noNsItemTextNode->isDefaultNamespace() ? 'true' : 'false') . "\n";
84
85        // 空文字列（名前空間なし）を指定した場合: このノードの名前空間が空文字列であるか。
86        // 期待値: true (一致するため)
87        echo "isDefaultNamespace(''): " . ($noNsItemTextNode->isDefaultNamespace('') ? 'true' : 'false') . "\n";
88
89        // 親要素のデフォルト名前空間を指定した場合
90        // 期待値: false (名前空間が解除されているため)
91        echo "isDefaultNamespace('http://example.com/default-ns'): " . ($noNsItemTextNode->isDefaultNamespace('http://example.com/default-ns') ? 'true' : 'false') . "\n";
92        echo "\n";
93    } else {
94        echo "<no_ns_item>要素内のテキストノードが見つかりませんでした。\n\n";
95    }
96
97    // --- ケース3: 親要素のデフォルト名前空間を継承する別のテキストノード ---
98    // <another_item>要素内のテキストノードを取得します。
99    // <root>要素のデフォルト名前空間 "http://example.com/default-ns" を継承します。
100    $anotherItemTextNode = $xpath->query('//another_item/text()')->item(0);
101
102    if ($anotherItemTextNode instanceof Dom\Text) {
103        echo "--- <another_item>要素内のテキストノードの確認 ---\n";
104        echo "ノード値: \"" . $anotherItemTextNode->nodeValue . "\"\n";
105
106        // 引数なしの場合: このノードが何らかのデフォルト名前空間に属しているか。
107        // 期待値: true (http://example.com/default-ns に属するため)
108        echo "isDefaultNamespace() (引数なし): " . ($anotherItemTextNode->isDefaultNamespace() ? 'true' : 'false') . "\n";
109
110        // 期待されるデフォルト名前空間を指定した場合
111        // 期待値: true (一致するため)
112        echo "isDefaultNamespace('http://example.com/default-ns'): " . ($anotherItemTextNode->isDefaultNamespace('http://example.com/default-ns') ? 'true' : 'false') . "\n";
113        echo "\n";
114    } else {
115        echo "<another_item>要素内のテキストノードが見つかりませんでした。\n\n";
116    }
117}
118
119// サンプルコードを実行
120demonstrateDefaultNamespaceCheck();

Dom\Text::isDefaultNamespace() メソッドは、XMLドキュメント内のテキストノードが特定のデフォルト名前空間に属しているかを判定するために使用されます。このメソッドは、Dom\Text クラスのインスタンス、つまりXMLのテキストコンテンツを表すオブジェクトに対して呼び出します。

引数 $namespace はオプションの文字列型で、比較したい名前空間URIを指定します。この引数を省略した場合、メソッドは対象のテキストノードが空文字列ではない何らかのデフォルト名前空間を持つ場合に true を返します。これは、そのノードが何らかの名前空間に属していることを示します。

引数に名前空間URIを指定した場合、そのURIがテキストノードのデフォルト名前空間と完全に一致するかどうかを判定します。一致すれば true を、そうでなければ false を戻り値として返します。例えば、XML要素に xmlns="http://example.com/ns" のようにデフォルト名前空間が宣言されている場合、その子孫テキストノードに対して isDefaultNamespace('http://example.com/ns') を呼び出すと true となります。逆に、xmlns="" で名前空間が明示的に解除されたノードは isDefaultNamespace('') で true となり、引数なしや他のURIでは false となります。

このメソッドは、XMLの構造を解析し、特に名前空間の扱いに厳密なシステムでテキストコンテンツの名前空間情報を正確に検証する際に役立ちます。

Copy
1<?php
2
3/**
4 * Dom\Text::isDefaultNamespace() メソッドの使用例。
5 *
6 * このメソッドはXMLドキュメント内のテキストノードの親要素が、
7 * 指定された名前空間をデフォルト名前空間として持っているかをチェックします。
8 *
9 * 【重要】この「名前空間」はXMLの名前空間の概念であり、
10 * PHPコードにおける「namespace MyNamespace;」とは異なるものです。
11 * XMLの構造内で、どのURIがデフォルトの名前空間として定義されているかを確認するために使用されます。
12 */
13function demonstrateDomTextIsDefaultNamespace(): void
14{
15    // 1. サンプルXMLドキュメントを定義
16    // 異なるデフォルト名前空間を持つ要素を含むXML文字列を作成します。
17    // - <root> は "http://example.com/ns/root" をデフォルト名前空間とする
18    // - <elementA> は <root> からデフォルト名前空間を継承する
19    // - <elementB> は独自の "http://example.com/ns/elementB" をデフォルト名前空間として定義する
20    // - <elementC> はプレフィックス付き名前空間を定義するが、
21    //   デフォルト名前空間は <root> から継承されたものとなる
22    $xmlString = <<<XML
23<root xmlns="http://example.com/ns/root">
24    <elementA>テキストA</elementA>
25    <elementB xmlns="http://example.com/ns/elementB">テキストB</elementB>
26    <elementC xmlns:prefix="http://example.com/ns/prefixed">テキストC</elementC>
27</root>
28XML;
29
30    // DOMDocument を作成し、XML文字列をロード
31    $dom = new DOMDocument();
32    $dom->loadXML($xmlString);
33
34    // 2. 各要素の子である Dom\Text ノードを取得
35    // Dom\Text::isDefaultNamespace は Dom\Text クラスのメソッドなので、
36    // まず要素ノードからその子であるテキストノードを取得する必要があります。
37
38    // <elementA> のテキストノード (デフォルトNSは 'http://example.com/ns/root' を継承)
39    $elementA = $dom->getElementsByTagName('elementA')->item(0);
40    $textNodeA = $elementA->firstChild; // Dom\Text インスタンス
41
42    // <elementB> のテキストノード (デフォルトNSは 'http://example.com/ns/elementB')
43    $elementB = $dom->getElementsByTagName('elementB')->item(0);
44    $textNodeB = $elementB->firstChild; // Dom\Text インスタンス
45
46    // <elementC> のテキストノード (デフォルトNSは 'http://example.com/ns/root' を継承)
47    $elementC = $dom->getElementsByTagName('elementC')->item(0);
48    $textNodeC = $elementC->firstChild; // Dom\Text インスタンス
49
50
51    // 3. isDefaultNamespace メソッドを呼び出し、結果を出力
52
53    echo "--- <elementA> のテキストノードの確認 ---\n";
54    echo "  期待されるデフォルト名前空間: http://example.com/ns/root\n";
55    echo "  'http://example.com/ns/root' がデフォルトか: " .
56        ($textNodeA->isDefaultNamespace('http://example.com/ns/root') ? "はい" : "いいえ") . "\n"; // true
57    echo "  'http://example.com/ns/elementB' がデフォルトか: " .
58        ($textNodeA->isDefaultNamespace('http://example.com/ns/elementB') ? "はい" : "いいえ") . "\n\n"; // false
59
60    echo "--- <elementB> のテキストノードの確認 ---\n";
61    echo "  期待されるデフォルト名前空間: http://example.com/ns/elementB\n";
62    echo "  'http://example.com/ns/elementB' がデフォルトか: " .
63        ($textNodeB->isDefaultNamespace('http://example.com/ns/elementB') ? "はい" : "いいえ") . "\n"; // true
64    echo "  'http://example.com/ns/root' がデフォルトか: " .
65        ($textNodeB->isDefaultNamespace('http://example.com/ns/root') ? "はい" : "いいえ") . "\n\n"; // false
66
67    echo "--- <elementC> のテキストノードの確認 ---\n";
68    echo "  期待されるデフォルト名前空間: http://example.com/ns/root\n";
69    echo "  'http://example.com/ns/root' がデフォルトか: " .
70        ($textNodeC->isDefaultNamespace('http://example.com/ns/root') ? "はい" : "いいえ") . "\n"; // true
71    // <elementC> は 'http://example.com/ns/prefixed' をプレフィックス付きで定義しているが、
72    // これはデフォルト名前空間ではないため false となる
73    echo "  'http://example.com/ns/prefixed' がデフォルトか: " .
74        ($textNodeC->isDefaultNamespace('http://example.com/ns/prefixed') ? "はい" : "いいえ") . "\n"; // false
75    // 引数に null を渡した場合、有効な名前空間URIではないため通常は false となる
76    echo "  null がデフォルトか (通常はfalse): " .
77        ($textNodeC->isDefaultNamespace(null) ? "はい" : "いいえ") . "\n"; // false
78}
79
80// 関数を実行して、Dom\Text::isDefaultNamespace の動作を確認
81demonstrateDomTextIsDefaultNamespace();
82
83?>

Dom\Text::isDefaultNamespaceメソッドは、XMLドキュメントの特定のテキストノードが、与えられた名前空間URIをデフォルト名前空間として持っているかを確認するために使用されます。ここでいう「名前空間」は、PHPコードで利用するnamespaceキーワードとは異なり、XMLの構造におけるデフォルト名前空間の概念を指します。

このメソッドは、Dom\Textインスタンス（XML要素内のテキスト部分）に対して呼び出され、そのテキストノードの親要素が指定された名前空間URIをデフォルト名前空間として定義しているかをチェックします。

引数$namespaceには、確認したい名前空間のURIを文字列で渡します。もしnullが渡された場合、それは有効なデフォルト名前空間URIではないため、通常はfalseを返します。メソッドの戻り値は真偽値（bool）で、親要素が指定された名前空間をデフォルトとしていればtrue、そうでなければfalseを返します。

サンプルコードでは、異なるデフォルト名前空間の定義や継承を含むXML構造を作成し、それぞれのテキストノードに対してisDefaultNamespaceメソッドを適用しています。これにより、親要素からデフォルト名前空間を継承するケース、独自にデフォルト名前空間を定義するケース、そしてプレフィックス付き名前空間はデフォルト名前空間とは異なる扱いになるケースなど、具体的な挙動を確認することができます。このメソッドは、XMLドキュメントの名前空間の整合性を確認する際に役立ちます。