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

Copy
1<?php
2
3// システムエンジニアを目指す初心者向けに、
4// XMLドキュメントで「デフォルト名前空間」がどのように機能するかを示すサンプルコードです。
5// Dom\XMLDocument クラスは、PHP 8で導入された新しいDOM拡張の一部で、
6// XMLドキュメントをプログラムで操作するために使われます。
7
8// 1. 新しい Dom\XMLDocument インスタンスを作成します。
9//    これはXMLドキュメント全体のコンテナになります。
10$xml = new Dom\XMLDocument('1.0', 'UTF-8');
11
12// 2. デフォルト名前空間を持つルート要素 'bookstore' を作成します。
13//    createElementNS() の第一引数で名前空間URI (Uniform Resource Identifier) を指定します。
14//    これにより、'bookstore' 要素とその直下の子要素で、明示的に名前空間が指定されない限り、
15//    'http://example.com/ns/books' がデフォルトの名前空間として扱われます。
16$rootElement = $xml->createElementNS('http://example.com/ns/books', 'bookstore');
17$xml->appendChild($rootElement);
18
19// 3. ルート要素に対して isDefaultNamespace() メソッドを使ってデフォルト名前空間を確認します。
20//    isDefaultNamespace() は、指定された名前空間URIが要素のデフォルト名前空間であるかどうかを真偽値で返します。
21echo "--- ルート要素 ('bookstore') の確認 ---\n";
22
23// 指定した名前空間URIがルート要素のデフォルト名前空間であるか確認
24$isDefaultRoot = $rootElement->isDefaultNamespace('http://example.com/ns/books');
25echo "  'http://example.com/ns/books' は 'bookstore' のデフォルト名前空間ですか？ " . ($isDefaultRoot ? 'はい' : 'いいえ') . "\n"; // 期待値: はい
26
27// 異なる名前空間URIがデフォルトであるか確認
28$isDifferentDefaultRoot = $rootElement->isDefaultNamespace('http://example.com/ns/other');
29echo "  'http://example.com/ns/other' は 'bookstore' のデフォルト名前空間ですか？ " . ($isDifferentDefaultRoot ? 'はい' : 'いいえ') . "\n"; // 期待値: いいえ
30
31// 4. 親要素のデフォルト名前空間を継承する子要素 'book' を作成します。
32//    createElement() を使うと、名前空間URIを指定しないため、
33//    親要素（この場合は 'bookstore'）のデフォルト名前空間を自動的に継承します。
34$bookElement = $xml->createElement('book');
35$rootElement->appendChild($bookElement);
36
37echo "\n--- 子要素 ('book' - デフォルト名前空間を継承) の確認 ---\n";
38// 親から継承したデフォルト名前空間が、子要素 'book' にも適用されているか確認
39$isDefaultBookInherited = $bookElement->isDefaultNamespace('http://example.com/ns/books');
40echo "  'http://example.com/ns/books' は 'book' のデフォルト名前空間ですか (継承)？ " . ($isDefaultBookInherited ? 'はい' : 'いいえ') . "\n"; // 期待値: はい
41
42// 5. 独自のデフォルト名前空間を持つ子要素 'magazine' を作成します。
43//    この要素は、親のデフォルト名前空間を上書きし、独自のデフォルト名前空間を持ちます。
44$magazineElement = $xml->createElementNS('http://example.com/ns/magazines', 'magazine');
45$rootElement->appendChild($magazineElement);
46
47echo "\n--- 子要素 ('magazine' - 独自のデフォルト名前空間) の確認 ---\n";
48// 独自のデフォルト名前空間が 'magazine' 要素で有効であるか確認
49$isDefaultMagazineOwn = $magazineElement->isDefaultNamespace('http://example.com/ns/magazines');
50echo "  'http://example.com/ns/magazines' は 'magazine' のデフォルト名前空間ですか？ " . ($isDefaultMagazineOwn ? 'はい' : 'いいえ') . "\n"; // 期待値: はい
51
52// 親から継承されるはずだった名前空間が、'magazine' で上書きされたためデフォルトではないことを確認
53$isDefaultMagazineParent = $magazineElement->isDefaultNamespace('http://example.com/ns/books');
54echo "  'http://example.com/ns/books' は 'magazine' のデフォルト名前空間ですか？ " . ($isDefaultMagazineParent ? 'はい' : 'いいえ') . "\n"; // 期待値: いいえ
55
56// 6. デフォルト名前空間を「空」に設定する要素 'oldbook' を作成します。
57//    createElementNS() の第一引数に空文字列 '' を指定すると、
58//    その要素とその子要素ではデフォルト名前空間が明示的に解除されます。
59$oldBookElement = $xml->createElementNS('', 'oldbook');
60$bookElement->appendChild($oldBookElement); // 'book' の子要素として追加
61
62echo "\n--- 子要素 ('oldbook' - デフォルト名前空間が空) の確認 ---\n";
63// デフォルト名前空間が空文字列であるか確認
64$isEmptyDefaultOldBook = $oldBookElement->isDefaultNamespace('');
65echo "  空文字列 '' は 'oldbook' のデフォルト名前空間ですか？ " . ($isEmptyDefaultOldBook ? 'はい' : 'いいえ') . "\n"; // 期待値: はい
66
67// 親から継承されるはずだった名前空間が、空に設定されたためデフォルトではないことを確認
68$isDefaultOldBookParent = $oldBookElement->isDefaultNamespace('http://example.com/ns/books');
69echo "  'http://example.com/ns/books' は 'oldbook' のデフォルト名前空間ですか？ " . ($isDefaultOldBookParent ? 'はい' : 'いいえ') . "\n"; // 期待値: いいえ
70
71// 最終的なXML構造をデバッグ用に表示する場合、以下のコメントアウトを解除してください。
72// echo "\n--- 生成されたXMLドキュメント ---\n";
73// echo $xml->saveXML();
74
75?>

PHP 8で導入されたDom\XMLDocumentクラスは、XMLドキュメントを効率的に操作するための機能を提供します。その中のisDefaultNamespaceメソッドは、特定のXML要素が指定されたURIをデフォルトの名前空間として持っているかどうかを判定するために使われます。このメソッドは?string $namespaceという引数を取り、これは確認したい名前空間URIを渡します。引数にnullを渡すことも可能ですが、通常はURI文字列または空文字列を指定します。戻り値はbool型で、要素のデフォルト名前空間が引数と一致すればtrueを、そうでなければfalseを返します。

「デフォルト名前空間」とは、XML要素で名前空間が明示的に指定されていない場合に自動的に適用される標準の名前空間です。これはXML文書を整理し、異なるスキーマで定義された要素が混在しても衝突しないようにするために使用されます。

サンプルコードでは、まずcreateElementNSでルート要素'bookstore'にhttp://example.com/ns/booksというデフォルト名前空間を設定しています。isDefaultNamespaceを使うと、この要素がそのURIをデフォルトの名前空間として認識していることをtrueで確認できます。子要素'book'は親要素の名前空間を継承するため、isDefaultNamespaceでも同じURIがデフォルトとして認識されます。一方、子要素'magazine'のようにcreateElementNSで別のURIを指定すると、その要素は新しいURIを独自のデフォルト名前空間とし、親の名前空間は上書きされます。さらに、createElementNSで空文字列''を名前空間URIとして指定した'oldbook'要素の場合、その要素ではデフォルト名前空間が明示的に解除され、isDefaultNamespace('')でtrueが返されることを確認できます。このメソッドを利用することで、XMLドキュメント内の各要素の名前空間の適用状況を正確に把握し、プログラムでXML構造を安全に処理することが可能になります。

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::isDefaultNamespace メソッドの使用例を示します。
5 *
6 * この関数は、XMLドキュメント内で名前空間がどのように定義され、
7 * 特定の名前空間URIがそのコンテキストでデフォルト名前空間であるかどうかを
8 * isDefaultNamespace メソッドがどのように判定するかを実演します。
9 *
10 * システムエンジニアを目指す初心者向けに、XML名前空間の基本的な考え方と
11 * PHPでのチェック方法を簡潔に示します。
12 */
13function demonstrateXmlDefaultNamespaceCheck(): void
14{
15    echo "--- Dom\\XMLDocument::isDefaultNamespace デモ ---\n\n";
16
17    // 1. デフォルト名前空間を定義したXML文字列を作成します。
18    //    <bookstore>要素にデフォルト名前空間 "http://example.com/books" を定義しています。
19    //    これにより、プレフィックスなしの子要素 (<book>, <notes>, <no-ns-tag>) は
20    //    このデフォルト名前空間に属することになります。
21    //    <info:metadata>要素は、プレフィックス付きで別の名前空間を定義しています。
22    $xmlString = <<<XML
23<?xml version="1.0" encoding="UTF-8"?>
24<bookstore xmlns="http://example.com/books">
25    <book id="bk101">
26        <title>PHP for Beginners</title>
27    </book>
28    <book id="bk102" xmlns:info="http://example.com/info">
29        <title>Advanced PHP</title>
30        <info:metadata>Some extra info.</info:metadata>
31    </book>
32    <notes>Important notes here.</notes>
33    <no-ns-tag>This tag has no explicit namespace.</no-ns-tag>
34</bookstore>
35XML;
36
37    echo "=== 生成されたXMLドキュメント ===\n";
38    echo $xmlString . "\n\n";
39
40    // 2. Dom\XMLDocument オブジェクトを初期化し、XML文字列を読み込みます。
41    $dom = new Dom\XMLDocument();
42    $dom->loadXML($xmlString);
43
44    // Dom\XMLDocument::isDefaultNamespace は、ドキュメントのルート要素のスコープにおいて、
45    // 引数で指定された名前空間URIがデフォルト名前空間であるかどうかを判定します。
46    // このXMLでは、ルート要素 <bookstore> のデフォルト名前空間は "http://example.com/books" です。
47
48    echo "=== Dom\\XMLDocument::isDefaultNamespace の結果 (ルート要素のコンテキスト) ===\n";
49
50    // ケース1: ルート要素で定義されたデフォルト名前空間URIを指定
51    $defaultNsUri = "http://example.com/books";
52    $isDefault1 = $dom->isDefaultNamespace($defaultNsUri);
53    echo "  - URI '{$defaultNsUri}' はデフォルト名前空間ですか？ " . ($isDefault1 ? "はい" : "いいえ") . "\n";
54    // 期待値: はい (ルート要素の xmlns に一致するため)
55
56    // ケース2: XML内で定義されているが、ルート要素のデフォルトではない名前空間URIを指定
57    // (例: プレフィックス付きで宣言された名前空間)
58    $prefixedNsUri = "http://example.com/info";
59    $isDefault2 = $dom->isDefaultNamespace($prefixedNsUri);
60    echo "  - URI '{$prefixedNsUri}' はデフォルト名前空間ですか？ " . ($isDefault2 ? "はい" : "いいえ") . "\n";
61    // 期待値: いいえ (これはプレフィックス付きの名前空間であり、ルート要素のデフォルトではないため)
62
63    // ケース3: 存在しない、またはXMLに関連しない名前空間URIを指定
64    $otherNsUri = "http://example.com/other";
65    $isDefault3 = $dom->isDefaultNamespace($otherNsUri);
66    echo "  - URI '{$otherNsUri}' はデフォルト名前空間ですか？ " . ($isDefault3 ? "はい" : "いいえ") . "\n";
67    // 期待値: いいえ
68
69    // ケース4: 名前空間URIとして null を指定
70    // null は「名前空間なし」を意味します。ルート要素にデフォルト名前空間が設定されているため、
71    // ドキュメント全体 (ルート要素のコンテキスト) では「名前空間なし」がデフォルトではないと判断されます。
72    $isDefault4 = $dom->isDefaultNamespace(null);
73    echo "  - URI 'null' (名前空間なし) はデフォルト名前空間ですか？ " . ($isDefault4 ? "はい" : "いいえ") . "\n";
74    // 期待値: いいえ (ルート要素にデフォルト名前空間が定義されているため)
75}
76
77// 関数を実行してデモを開始
78demonstrateXmlDefaultNamespaceCheck();
79
80?>

「Dom\XMLDocument::isDefaultNamespace」は、XMLドキュメントのルート要素において、指定された名前空間URIが「デフォルト名前空間」として設定されているかを判定するメソッドです。システムエンジニアを目指す方にとって、XMLで要素の所属を定義する「名前空間」の理解は重要です。

このメソッドは、引数 $namespace にチェックしたい名前空間のURIを文字列で受け取ります。もし $namespace に null を指定した場合、それは「名前空間が宣言されていない要素」がデフォルトであるかを判定することを意味します。戻り値は bool 型で、指定されたURIがデフォルト名前空間であれば true を、そうでなければ false を返します。

サンプルコードでは、<bookstore xmlns="http://example.com/books"> のようにデフォルト名前空間を定義したXMLを使用しています。このドキュメントのルート要素のコンテキストでは、「http://example.com/books」というURIがデフォルト名前空間として認識されるため、`$dom->isDefaultNamespace("http://example.com/books")` は true となります。一方、プレフィックス付きで宣言された名前空間や、定義されていないURI、あるいは null を指定した場合は false が返されます。これは、ルート要素で明示的にデフォルト名前空間が設定されているため、「名前空間なし」の状態はデフォルトではないと判断されるためです。このメソッドは、XMLの構造をプログラムで解析する際に、特定の名前空間がデフォルトとして扱われているかを確認するのに役立ちます。