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

Copy
1<?php
2
3/**
4 * Dom\Node::isDefaultNamespace メソッドのPHP 8での使用例。
5 *
6 * この関数は、XML要素が特定のURIをデフォルト名前空間として持っているかを確認する方法を示します。
7 * Dom\DocumentオブジェクトからロードしたXML文書内の要素に対してこのメソッドを適用します。
8 */
9function demonstrateIsDefaultNamespace(): void
10{
11    // Dom\Documentオブジェクトを初期化
12    // このオブジェクトはXML文書全体を表現します。
13    $dom = new Dom\Document();
14
15    // デフォルト名前空間が定義されたXMLをロード
16    // <root xmlns="http://www.example.com/default-ns"> の部分が、
17    // ルート要素とその子要素のデフォルト名前空間を定義しています。
18    $xmlString = '<root xmlns="http://www.example.com/default-ns"><item/></root>';
19    $dom->loadXML($xmlString);
20
21    echo "--- ロードしたXML文書 ---\n";
22    echo htmlspecialchars($xmlString) . "\n\n";
23
24    // ドキュメントのルート要素を取得
25    // isDefaultNamespaceメソッドは、Dom\Documentではなく、
26    // Dom\Element (Dom\Nodeを継承) などの特定のXMLノードに対して呼び出されます。
27    // ドキュメント内の特定の要素の名前空間をチェックするために使用します。
28    $rootElement = $dom->documentElement;
29
30    if ($rootElement === null) {
31        echo "エラー: XML文書にルート要素が見つかりませんでした。\n";
32        return;
33    }
34
35    echo "--- isDefaultNamespace() メソッドのテスト ---\n";
36    echo "テスト対象の要素: <" . $rootElement->nodeName . ">\n\n";
37
38    // テスト用の名前空間URIを定義
39    $defaultNsUri = 'http://www.example.com/default-ns';
40    $anotherNsUri = 'http://www.example.com/another-ns';
41    $emptyNsUri = ''; // 名前空間が定義されていない場合のURI
42
43    // ケース1: 実際のデフォルト名前空間URIでテスト
44    echo "名前空間URI '{$defaultNsUri}' が要素のデフォルト名前空間か？\n";
45    echo "結果: ";
46    var_dump($rootElement->isDefaultNamespace($defaultNsUri)); // true が期待される
47
48    // ケース2: 異なる名前空間URIでテスト
49    echo "\n名前空間URI '{$anotherNsUri}' が要素のデフォルト名前空間か？\n";
50    echo "結果: ";
51    var_dump($rootElement->isDefaultNamespace($anotherNsUri)); // false が期待される
52
53    // ケース3: 空の名前空間URIでテスト
54    // 今回のXMLにはデフォルト名前空間が設定されているため、空はデフォルトではありません。
55    echo "\n名前空間URI '{$emptyNsUri}' (名前空間なし) が要素のデフォルト名前空間か？\n";
56    echo "結果: ";
57    var_dump($rootElement->isDefaultNamespace($emptyNsUri)); // false が期待される (デフォルトが定義されているため)
58}
59
60// 関数を実行して、Dom\Node::isDefaultNamespace の動作を確認
61demonstrateIsDefaultNamespace();

PHPのDom\Node::isDefaultNamespaceメソッドは、XML文書中の特定の要素が、指定された名前空間URIをその要素のデフォルト名前空間として持っているかを確認するために使用されます。このメソッドは、Dom\Documentオブジェクト自体ではなく、XML要素を表すDom\Element（Dom\Nodeを継承）のような、具体的なXMLノードに対して呼び出します。

引数$namespaceURIには、確認したい名前空間のURIを文字列で渡します。メソッドの戻り値は真偽値（bool）です。指定されたURIが要素のデフォルト名前空間と一致すればtrueを返し、一致しなければfalseを返します。

サンプルコードでは、まずデフォルト名前空間が定義されたXML文字列をDom\Documentにロードしています。次に、ドキュメントのルート要素を取得し、その要素に対してisDefaultNamespaceメソッドを呼び出しています。定義されているデフォルト名前空間URIでテストした場合はtrueが、それ以外のURI（異なるURIや空のURI）でテストした場合はfalseが返されることを通じて、このメソッドが要素のデフォルト名前空間を正確に識別する様子を示しています。これにより、XML文書の名前空間をプログラムで効率的に処理できます。

Copy
1<?php
2
3/**
4 * Dom\Document::isDefaultNamespace メソッドの使用例
5 *
6 * この関数は、指定されたXML文字列内のデフォルト名前空間が、
7 * 提供されたURIと一致するかどうかをDom\Document::isDefaultNamespaceメソッドを使用して確認します。
8 *
9 * XMLの名前空間（`xmlns="..."`）は、要素や属性を識別するためのユニークなURIです。
10 * デフォルト名前空間は、プレフィックスなしで定義された要素に適用されます。
11 *
12 * @param string $xmlString 検証対象のXMLドキュメント文字列。
13 * @param string $namespaceUri チェックしたい名前空間URI。
14 * @return void
15 */
16function checkDefaultNamespace(string $xmlString, string $namespaceUri): void
17{
18    echo "--- 検証XMLドキュメント --- \n" . $xmlString . "\n";
19    echo "--- チェックするURI: '" . ($namespaceUri === '' ? "'' (空文字列)" : $namespaceUri) . "' ---\n";
20
21    try {
22        // Dom\Document オブジェクトを初期化
23        $dom = new Dom\Document();
24        // XML文字列をロード。loadXML() は内部でパースを行います。
25        $dom->loadXML($xmlString);
26
27        // Dom\Document::isDefaultNamespace を呼び出し
28        // このメソッドは、XMLドキュメントのルート要素に適用されるデフォルト名前空間が、
29        // 引数で指定された $namespaceUri と一致するかどうかを論理値 (true/false) で返します。
30        $isDefault = $dom->isDefaultNamespace($namespaceUri);
31
32        echo "結果: isDefaultNamespace('" . $namespaceUri . "') は " . ($isDefault ? 'true' : 'false') . " を返しました。\n\n";
33
34    } catch (Throwable $e) {
35        // XMLのパースエラーなどが発生した場合にキャッチ
36        echo "エラーが発生しました: " . $e->getMessage() . "\n\n";
37    }
38}
39
40// --- 使用例 ---
41
42// 例1: XMLにデフォルト名前空間が定義されており、チェックするURIと一致する場合
43// ここでは 'http://example.com/ns/books' がデフォルト名前空間として定義されています。
44$xml1 = '<books xmlns="http://example.com/ns/books">
45    <book><title>PHP入門</title></book>
46</books>';
47checkDefaultNamespace($xml1, 'http://example.com/ns/books');
48// 期待される出力: true
49
50// 例2: XMLにデフォルト名前空間が定義されているが、チェックするURIと一致しない場合
51// XMLのデフォルト名前空間は 'http://example.com/ns/books' ですが、
52// チェックするURIは 'http://example.com/ns/magazines' です。
53$xml2 = '<books xmlns="http://example.com/ns/books">
54    <book><title>PHP入門</title></book>
55</books>';
56checkDefaultNamespace($xml2, 'http://example.com/ns/magazines');
57// 期待される出力: false
58
59// 例3: XMLにデフォルト名前空間が定義されているが、空文字列をチェックする場合
60// 空文字列は有効な名前空間URIとはみなされません。
61$xml3 = '<books xmlns="http://example.com/ns/books">
62    <book><title>PHP入門</title></book>
63</books>';
64checkDefaultNamespace($xml3, '');
65// 期待される出力: false
66
67// 例4: XMLにデフォルト名前空間が定義されていない場合 (xmlns属性がない)
68// この場合、要素は名前空間なしとして扱われます。
69$xml4 = '<books>
70    <book><title>PHP入門</title></book>
71</books>';
72checkDefaultNamespace($xml4, 'http://example.com/ns/books');
73// 期待される出力: false
74
75// 例5: XMLにデフォルト名前空間が定義されていない状態で、空文字列をチェックする場合
76// デフォルト名前空間が存在しないため、空文字列も一致しません。
77$xml5 = '<books>
78    <book><title>PHP入門</title></book>
79</books>';
80checkDefaultNamespace($xml5, '');
81// 期待される出力: false

PHP 8のDom\Document::isDefaultNamespaceメソッドは、XMLドキュメントのデフォルト名前空間が、特定のURIと一致するかどうかを判定するために利用されます。XMLにおける名前空間とは、要素や属性を他のドキュメントやスキーマから区別し、名前の衝突を防ぐためのユニークな識別子（URI）です。特に、xmlns="..."のようにプレフィックスなしで定義された名前空間が「デフォルト名前空間」として、その配下の全ての要素に適用されます。

このメソッドはstring $namespaceURIという引数を一つ取り、検証したい名前空間のURI文字列を指定します。戻り値はbool型で、対象のXMLドキュメントに定義されているデフォルト名前空間が、引数で渡された$namespaceURIと完全に一致する場合にtrueを返します。一致しない場合や、XMLドキュメント自体にデフォルト名前空間が定義されていない場合はfalseを返します。例えば、デフォルト名前空間が設定されていないXMLに対して特定のURIをチェックした場合や、空文字列をURIとして指定した場合などもfalseとなります。

提供されたサンプルコードでは、まずDom\DocumentオブジェクトにXML文字列をロードし、その後isDefaultNamespaceメソッドを呼び出して検証を行います。複数の使用例を通じて、XMLドキュメントのデフォルト名前空間と指定されたURIが一致するパターン、一致しないパターン、名前空間が定義されていないパターンなど、様々なケースでメソッドがどのような論理値（trueまたはfalse）を返すかを確認できるようになっています。