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

Copy
1<?php
2
3// DOMDocument を作成し、XML ドキュメントをロードします。
4// ここでは異なる名前空間を持つXML構造を定義しています。
5$dom = new DOMDocument();
6$dom->loadXML(
7    <<<XML
8    <root xmlns="http://example.com/default" xmlns:pref="http://example.com/prefix">
9        <element1>デフォルト名前空間の子要素</element1>
10        <pref:element2>プレフィックス付き名前空間の子要素</pref:element2>
11        <element3 xmlns="http://example.com/another">別のデフォルト名前空間の子要素</element3>
12    </root>
13    XML
14);
15
16// ルート要素を取得します。
17// DOMElement::isDefaultNamespace メソッドは、指定された名前空間 URI が
18// その要素のデフォルト名前空間であるかどうかをブール値で返します。
19$rootElement = $dom->documentElement;
20
21if ($rootElement instanceof DOMElement) {
22    echo "--- ルート要素 (root) のデフォルト名前空間チェック ---" . PHP_EOL;
23
24    // 'root' 要素のデフォルト名前空間が 'http://example.com/default' であるかを確認します。
25    $isRootDefaultNs = $rootElement->isDefaultNamespace("http://example.com/default");
26    echo "root のデフォルト名前空間は 'http://example.com/default' ですか？ " . ($isRootDefaultNs ? "はい" : "いいえ") . PHP_EOL;
27
28    // 存在しない名前空間 URI がデフォルトであるかを確認します。
29    $isRootNonExistentNs = $rootElement->isDefaultNamespace("http://example.com/nonexistent");
30    echo "root のデフォルト名前空間は 'http://example.com/nonexistent' ですか？ " . ($isRootNonExistentNs ? "はい" : "いいえ") . PHP_EOL;
31}
32
33// XPath を使用して特定の子要素を取得し、それぞれのデフォルト名前空間をチェックします。
34$xpath = new DOMXPath($dom);
35
36// element1: 親からデフォルト名前空間 'http://example.com/default' を継承しています。
37$element1 = $xpath->query('/root/element1')->item(0);
38if ($element1 instanceof DOMElement) {
39    echo PHP_EOL . "--- element1 のデフォルト名前空間チェック ---" . PHP_EOL;
40    $isElement1DefaultNs = $element1->isDefaultNamespace("http://example.com/default");
41    echo "element1 のデフォルト名前空間は 'http://example.com/default' ですか？ " . ($isElement1DefaultNs ? "はい" : "いいえ") . PHP_EOL;
42}
43
44// element2: 'pref:' プレフィックス付きの名前空間 'http://example.com/prefix' を持っています。
45// これはデフォルト名前空間ではありません。
46$element2 = $xpath->query('/root/pref:element2')->item(0);
47if ($element2 instanceof DOMElement) {
48    echo PHP_EOL . "--- element2 のデフォルト名前空間チェック ---" . PHP_EOL;
49    // element2 の名前空間 'http://example.com/prefix' はデフォルト名前空間ではないため 'いいえ' となります。
50    $isElement2DefaultNs = $element2->isDefaultNamespace("http://example.com/prefix");
51    echo "element2 のデフォルト名前空間は 'http://example.com/prefix' ですか？ " . ($isElement2DefaultNs ? "はい" : "いいえ") . PHP_EOL;
52    // 親のデフォルト名前空間も element2 にとってはデフォルトではありません。
53    $isElement2InheritedDefaultNs = $element2->isDefaultNamespace("http://example.com/default");
54    echo "element2 のデフォルト名前空間は 'http://example.com/default' ですか？ " . ($isElement2InheritedDefaultNs ? "はい" : "いいえ") . PHP_EOL;
55}
56
57// element3: 自身のデフォルト名前空間を 'http://example.com/another' に上書きしています。
58$element3 = $xpath->query('/root/element3')->item(0);
59if ($element3 instanceof DOMElement) {
60    echo PHP_EOL . "--- element3 のデフォルト名前空間チェック ---" . PHP_EOL;
61    $isElement3DefaultNs = $element3->isDefaultNamespace("http://example.com/another");
62    echo "element3 のデフォルト名前空間は 'http://example.com/another' ですか？ " . ($isElement3DefaultNs ? "はい" : "いいえ") . PHP_EOL;
63    // 親から継承される 'http://example.com/default' は element3 にとってはデフォルトではありません。
64    $isElement3InheritedDefaultNs = $element3->isDefaultNamespace("http://example.com/default");
65    echo "element3 のデフォルト名前空間は 'http://example.com/default' ですか？ " . ($isElement3InheritedDefaultNs ? "はい" : "いいえ") . PHP_EOL;
66}

PHP 8のDOMElement::isDefaultNamespaceメソッドは、XMLドキュメント内の特定の要素が、指定された名前空間URIをデフォルト名前空間として使用しているかどうかを判定するために利用されます。このメソッドは、引数として確認したい名前空間URIを文字列で受け取り、その名前空間が要素のデフォルト名前空間であればtrueを、そうでなければfalseをブール値で返します。

サンプルコードでは、複数の名前空間を持つXMLドキュメントを読み込み、それぞれの要素でisDefaultNamespaceの挙動を確認しています。ルート要素はhttp://example.com/defaultをデフォルト名前空間とし、その子要素であるelement1はこのデフォルト名前空間を継承しています。そのため、これらの要素に対してhttp://example.com/defaultを指定するとtrueが返されます。一方、pref:element2はprefというプレフィックスを持つ名前空間http://example.com/prefixを使用しているため、これはデフォルト名前空間ではありません。また、element3は自身のデフォルト名前空間をhttp://example.com/anotherに上書きしています。これらの要素に対して、異なる名前空間URIや親から継承されたデフォルト名前空間URIを指定してisDefaultNamespaceを呼び出すと、期待通りfalseが返されることが確認できます。このメソッドを使うことで、要素がどのデフォルト名前空間に属しているかを正確に判別できます。

Copy
1<?php
2
3/**
4 * Dom\Notation::isDefaultNamespace メソッドのサンプルコード。
5 *
6 * このメソッドは、ノードが特定のネームスペースURIをデフォルトネームスペースとして持っているかを確認します。
7 * Dom\Notation クラスは XML DTD 内の表記 (NOTATION) を表し、XML要素の xmlns 属性のように
8 * デフォルトネームスペースを定義するノードではないため、通常このメソッドは常に false を返します。
9 *
10 * @param string $xmlString DTD定義とnotation要素を含むXML文字列。
11 */
12function demonstrateNotationDefaultNamespace(string $xmlString): void
13{
14    $dom = new DOMDocument();
15    $dom->loadXML($xmlString);
16
17    $notation = null;
18    // XMLドキュメントからDOCTYPE (DTD) ノードを取得し、その中の表記リストを調べます。
19    // 最初に見つかった表記ノードを取得します。
20    if ($dom->doctype instanceof DOMDocumentType && $dom->doctype->notations->length > 0) {
21        $notation = $dom->doctype->notations->item(0);
22    }
23
24    if ($notation instanceof Dom\Notation) {
25        echo "取得したDom\\Notationの名称: " . $notation->nodeName . PHP_EOL;
26
27        // Dom\NotationはXML要素のように「デフォルトネームスペースを定義する」ものではないため、
28        // 以下のチェック結果は通常 false となります。
29
30        // 1. 引数に null を渡し、ノードが任意のデフォルトネームスペースを持っているかを確認します。
31        $isDefaultWithNull = $notation->isDefaultNamespace(null);
32        echo "  - null を指定した場合 (任意のデフォルトネームスペースか): " . ($isDefaultWithNull ? 'true' : 'false') . PHP_EOL;
33
34        // 2. 特定のネームスペースURIを渡し、そのURIがデフォルトネームスペースであるかを確認します。
35        $testNamespaceUri = "http://example.com/my-notation-namespace";
36        $isDefaultWithUri = $notation->isDefaultNamespace($testNamespaceUri);
37        echo "  - '{$testNamespaceUri}' を指定した場合 (特定のデフォルトネームスペースか): " . ($isDefaultWithUri ? 'true' : 'false') . PHP_EOL;
38
39    } else {
40        echo "Dom\\Notation オブジェクトを取得できませんでした。" . PHP_EOL;
41        echo "XML文字列にDTD定義とNOTATION要素が正しく含まれているか確認してください。" . PHP_EOL;
42    }
43}
44
45// DTDで 'gif' という表記 (NOTATION) を定義したXML文字列の例。
46// このNOTATIONは、外部のGIF画像フォーマットを参照するものと想定されます。
47$sampleXmlWithNotation = <<<XML
48<!DOCTYPE document [
49  <!NOTATION gif SYSTEM "image/gif" PUBLIC "-//W3C//DTD GIF 89a//EN">
50  <!ELEMENT document EMPTY>
51]>
52<document/>
53XML;
54
55// 定義した関数を実行し、Dom\Notation::isDefaultNamespace の動作を示します。
56demonstrateNotationDefaultNamespace($sampleXmlWithNotation);
57

Dom\Notation::isDefaultNamespaceメソッドは、XMLのノードが特定のネームスペースURIをデフォルトネームスペースとして持っているかを確認します。このメソッドはDom\Notationクラスに属しており、Dom\NotationはXMLのDTD（Document Type Definition）内で定義される「表記」を扱います。XMLの要素（タグ）のようにxmlns属性などで直接ネームスペースを定義するノードではないため、通常このメソッドは常にfalseを返します。

引数$namespaceには、確認したいネームスペースURIを文字列で指定します。nullを指定すると、ノードが「任意の」デフォルトネームスペースを持っているかを確認します。戻り値は、指定されたネームスペースがデフォルトとして設定されていればtrue、そうでなければfalseのブール値を返します。

サンプルコードでは、DTDで定義されたnotation要素からDom\Notationオブジェクトを取得しています。その後、isDefaultNamespaceメソッドをnullと特定のURI文字列でそれぞれ呼び出して動作を確認しています。Dom\Notationがデフォルトネームスペースを定義しない性質から、いずれの場合もfalseが出力されることが示されています。このメソッドは、主にXML要素など、ネームスペースを定義する可能性のあるノードで利用される際に真価を発揮します。