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

Copy
1<?php
2
3/**
4 * DOMEntity::isDefaultNamespace の使用例を示します。
5 * このメソッドはDOMNodeから継承されており、指定された名前空間URIがノードのデフォルトの名前空間であるかを確認します。
6 * DTDエンティティ（DOMEntity）は通常XML名前空間とは直接関連しないため、このメソッドはほとんどの場合falseを返します。
7 */
8function demonstrateDomEntityDefaultNamespace(): void
9{
10    // 1. DOMDocumentを作成します。
11    $dom = new DOMDocument();
12    $dom->preserveWhiteSpace = false; // 整形のために空白ノードを保持しない設定
13    $dom->formatOutput = true;        // 出力時にXMLを整形する設定
14
15    // 2. 内部DTDサブセットでエンティティを定義するXMLをロードします。
16    // <root/> 要素と <!DOCTYPE> 宣言内に "example" という名前のエンティティを定義しています。
17    $xmlString = <<<'XML'
18<!DOCTYPE root [
19  <!ENTITY example "Hello World">
20]>
21<root/>
22XML;
23
24    $dom->loadXML($xmlString);
25
26    // 3. ドキュメントタイプ (DOCTYPE) ノードを取得します。
27    // XMLドキュメントには常に1つのDOMDocumentTypeノードが存在する可能性があります。
28    $doctype = $dom->doctype;
29
30    if ($doctype instanceof DOMDocumentType) {
31        // 4. ドキュメントタイプからエンティティのリストを取得し、特定のDOMEntityノードを取得します。
32        // $doctype->entities は DOMNamedNodeMap で、エンティティ定義のリストを保持します。
33        $entities = $doctype->entities;
34        $entity = $entities->getNamedItem('example');
35
36        if ($entity instanceof DOMEntity) {
37            echo "DOMEntity 'example' が見つかりました。\n";
38
39            // 5. isDefaultNamespace メソッドを呼び出し、結果を表示します。
40            // DOMEntityは通常、自身にXML名前空間URIを持たないため ($entity->namespaceURI は null)、
41            // どんな名前空間URIを渡しても、このメソッドは通常 false を返します。
42            $namespaceUriToCheck = "http://www.example.com/ns";
43            $isDefault = $entity->isDefaultNamespace($namespaceUriToCheck);
44
45            echo "指定された名前空間URI '{$namespaceUriToCheck}' が 'example' エンティティのデフォルトの名前空間ですか？ ";
46            var_dump($isDefault); // 通常は false が出力されます
47
48            // 名前空間がない状態（空文字列）がデフォルトであるか確認する場合。
49            // DOMEntityのnamespaceURIは通常 null のため、空文字列と比較しても一致しません。
50            $isDefaultEmptyString = $entity->isDefaultNamespace('');
51            echo "空文字列の名前空間URIが 'example' エンティティのデフォルトの名前空間ですか？ ";
52            var_dump($isDefaultEmptyString); // 通常は false が出力されます
53
54            // 補足: DOMEntityのnamespaceURIプロパティを確認します。
55            // DTDで定義されるエンティティはXML名前空間とは直接関係がないため、
56            // そのnamespaceURIプロパティは通常 null です。
57            echo "DOMEntity 'example' の namespaceURI プロパティ: ";
58            var_dump($entity->namespaceURI); // 通常は null が出力されます
59        } else {
60            echo "DOMEntity 'example' が見つかりませんでした。XMLのDTD定義を確認してください。\n";
61        }
62    } else {
63        echo "XMLにDOCTYPE（DTD）が見つかりませんでした。\n";
64    }
65}
66
67// 関数を実行します。
68demonstrateDomEntityDefaultNamespace();
69

PHP 8のDOMEntity::isDefaultNamespaceメソッドは、指定された名前空間URIがノードのデフォルトの名前空間であるかを確認するために使用されます。引数$namespaceには、確認したい名前空間URIを文字列として指定します。このメソッドは真偽値（bool）を戻り値とし、指定されたURIがデフォルトの名前空間であればtrue、そうでなければfalseを返します。

このメソッドはDOMNodeクラスから継承されていますが、DOMEntityクラスはXMLドキュメント型定義（DTD）内で定義されるエンティティを表します。DTDエンティティは通常、XMLの名前空間とは直接的な関連を持たないため、DOMEntityインスタンスに対してこのメソッドを呼び出した場合、ほとんどのケースでfalseが返されます。これは、DOMEntityが持つnamespaceURIプロパティが基本的にnullであるため、どのような名前空間URIと比較してもデフォルトの名前空間とは見なされないためです。名前空間を扱うのは主にXML要素などのノードであり、エンティティの文脈ではこのメソッドの利用機会は限定的です。

Copy
1<?php
2
3// XML文書の準備
4// DTD (Document Type Definition) でエンティティを定義します。
5// エンティティノード (DOMEntity) はDOMNodeを継承しているため、
6// isDefaultNamespace メソッドを持ちますが、
7// エンティティノード自体はXML名前空間のスコープを直接定義しないのが一般的です。
8$xml = <<<XML
9<!DOCTYPE root [
10  <!ENTITY myNamespaceContentEntity "<element xmlns='http://example.com/inner-ns'>Inner Content</element>">
11  <!ENTITY mySimpleTextEntity "Just some text">
12]>
13<root xmlns="http://example.com/root-ns">
14    <child/>
15</root>
16XML;
17
18$dom = new DOMDocument();
19$dom->loadXML($xml);
20
21// XML文書のDOMDocumentTypeノードからエンティティのコレクションを取得します。
22$doctype = $dom->doctype;
23
24if ($doctype && $doctype->entities) {
25    // 名前が 'myNamespaceContentEntity' の DOMEntity オブジェクトを取得します。
26    // このエンティティの内容には名前空間を定義した要素が含まれていますが、
27    // isDefaultNamespace メソッドはエンティティノード自体が名前空間を宣言しているかをチェックします。
28    $entity1 = $doctype->entities->getNamedItem('myNamespaceContentEntity');
29
30    if ($entity1) {
31        $namespaceToCheck1 = 'http://example.com/root-ns'; // ドキュメントルートのデフォルト名前空間URI
32        // DOMEntity::isDefaultNamespace メソッドを呼び出して、
33        // 指定された名前空間URIがこのエンティティノードのデフォルト名前空間であるかを確認します。
34        // エンティティノード自体は xmlns 属性を持たないため、通常は false を返します。
35        $isDefault1 = $entity1->isDefaultNamespace($namespaceToCheck1);
36
37        echo "エンティティ '{$entity1->nodeName}' に対して、名前空間 '{$namespaceToCheck1}' がデフォルトか？: ";
38        echo ($isDefault1 ? 'はい' : 'いいえ') . "\n";
39    } else {
40        echo "エンティティ 'myNamespaceContentEntity' が見つかりませんでした。\n";
41    }
42
43    // 別のシンプルなエンティティで確認
44    $entity2 = $doctype->entities->getNamedItem('mySimpleTextEntity');
45    if ($entity2) {
46        $namespaceToCheck2 = 'http://example.com/non-existent-ns'; // 存在しない名前空間URI
47        $isDefault2 = $entity2->isDefaultNamespace($namespaceToCheck2);
48
49        echo "エンティティ '{$entity2->nodeName}' に対して、名前空間 '{$namespaceToCheck2}' がデフォルトか？: ";
50        echo ($isDefault2 ? 'はい' : 'いいえ') . "\n";
51    } else {
52        echo "エンティティ 'mySimpleTextEntity' が見つかりませんでした。\n";
53    }
54
55} else {
56    echo "XML文書にDTDが見つからないか、エンティティが定義されていません。\n";
57}
58
59?>

PHPのDOMEntity::isDefaultNamespaceメソッドは、指定された名前空間URIが「そのDOMエンティティノードの」デフォルト名前空間であるかどうかを判定するものです。引数$namespaceには確認したい名前空間のURIを文字列で渡し、メソッドは結果を真偽値（trueまたはfalse）で返します。

XMLの名前空間は、通常、要素（DOMElement）や属性（DOMAttr）に対してxmlns属性として宣言され、その要素や子孫要素に適用されるスコープを定義します。しかし、DOMEntityはXML文書のDTD（Document Type Definition）で定義されるエンティティを表すノードであり、エンティティノード自体がXML要素のようにxmlns属性を持って直接デフォルトの名前空間を宣言することは一般的ではありません。

この特性のため、サンプルコードが示すように、たとえエンティティの内容に名前空間を定義した要素が含まれていたとしても、DOMEntityオブジェクトに対してisDefaultNamespaceメソッドを呼び出した場合、エンティティノード自身がデフォルト名前空間を持たないため、ほとんどの場合でfalseが返されます。このメソッドはDOMNodeを継承する多くのノードタイプで利用できますが、DOMEntityの文脈における挙動を理解しておくことが重要です。