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

Copy
1<?php
2
3/**
4 * DOMNode::isDefaultNamespace メソッドの動作を示すサンプルコード。
5 *
6 * この関数は、XMLドキュメントを作成し、異なる名前空間の要素に対して
7 * 指定されたURIがデフォルト名前空間であるかをチェックする方法を実演します。
8 */
9function checkDefaultNamespaceExample(): void
10{
11    // DOMDocumentを作成し、XML宣言を追加。
12    // formatOutputをtrueに設定すると、出力XMLが見やすく整形されます。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    $dom->formatOutput = true;
15
16    // ルート要素 'root' を作成します。これは名前空間を持ちません。
17    $root = $dom->createElement('root');
18    $dom->appendChild($root);
19
20    // デフォルト名前空間 'http://www.example.com/ns1' を持つ要素 'item' を作成します。
21    // 要素名にプレフィックスがないため、指定されたURIがその要素のデフォルト名前空間となります。
22    $elementWithDefaultNs = $dom->createElementNS('http://www.example.com/ns1', 'item');
23    $root->appendChild($elementWithDefaultNs);
24
25    // 上記要素の子要素 'subitem' を作成します。
26    // 子要素は明示的に名前空間を指定しない限り、親要素のデフォルト名前空間を継承します。
27    $childOfDefaultNs = $dom->createElement('subitem');
28    $elementWithDefaultNs->appendChild($childOfDefaultNs);
29
30    // 'ns'というプレフィックスを持つ要素 'ns:item' を作成します。
31    // この場合、'http://www.example.com/ns1' は 'ns' プレフィックスに紐付けられますが、
32    // 'ns:item' 要素自体のデフォルト名前空間にはなりません。
33    // そのため、デフォルト名前空間は親要素 (root) から継承され、この場合は「名前空間なし」となります。
34    $elementWithPrefixedNs = $dom->createElementNS('http://www.example.com/ns1', 'ns:item');
35    $root->appendChild($elementWithPrefixedNs);
36
37    // 別のデフォルト名前空間 'http://www.example.com/ns2' を持つ要素 'otherItem' を作成します。
38    $elementWithOtherDefaultNs = $dom->createElementNS('http://www.example.com/ns2', 'otherItem');
39    $root->appendChild($elementWithOtherDefaultNs);
40
41    echo "--- 生成されたXMLドキュメント ---\n";
42    echo $dom->saveXML();
43    echo "---------------------------------\n\n";
44
45    echo "--- isDefaultNamespace メソッドのチェック結果 ---\n";
46
47    // $root 要素のデフォルト名前空間をチェックします。
48    // <root> は名前空間を定義していないため、デフォルト名前空間は「なし（空文字列）」です。
49    $isRootDefault = $root->isDefaultNamespace('');
50    echo "Is '' (no namespace) the default namespace for 'root'? " . ($isRootDefault ? 'Yes' : 'No') . "\n"; // 期待値: Yes
51
52    // $elementWithDefaultNs ('item') のデフォルト名前空間をチェックします。
53    // この要素は 'http://www.example.com/ns1' をデフォルト名前空間として宣言しています。
54    $isItemDefault1 = $elementWithDefaultNs->isDefaultNamespace('http://www.example.com/ns1');
55    echo "Is 'http://www.example.com/ns1' the default namespace for 'item'? " . ($isItemDefault1 ? 'Yes' : 'No') . "\n"; // 期待値: Yes
56
57    $isItemDefault2 = $elementWithDefaultNs->isDefaultNamespace('');
58    echo "Is '' (no namespace) the default namespace for 'item'? " . ($isItemDefault2 ? 'Yes' : 'No') . "\n"; // 期待値: No
59
60    // $childOfDefaultNs ('subitem') のデフォルト名前空間をチェックします。
61    // 子要素は親 ($elementWithDefaultNs) から 'http://www.example.com/ns1' を継承しています。
62    $isSubitemDefault = $childOfDefaultNs->isDefaultNamespace('http://www.example.com/ns1');
63    echo "Is 'http://www.example.com/ns1' the default namespace for 'subitem'? " . ($isSubitemDefault ? 'Yes' : 'No') . "\n"; // 期待値: Yes
64
65    // $elementWithPrefixedNs ('ns:item') のデフォルト名前空間をチェックします。
66    // この要素はプレフィックス 'ns' を 'http://www.example.com/ns1' に紐付けていますが、
67    // デフォルト名前空間は宣言していません。親の 'root' も名前空間を持たないため、
68    // この要素のデフォルト名前空間は「なし」となります。
69    $isPrefixedDefault1 = $elementWithPrefixedNs->isDefaultNamespace('');
70    echo "Is '' (no namespace) the default namespace for 'ns:item'? " . ($isPrefixedDefault1 ? 'Yes' : 'No') . "\n"; // 期待値: Yes
71
72    $isPrefixedDefault2 = $elementWithPrefixedNs->isDefaultNamespace('http://www.example.com/ns1');
73    echo "Is 'http://www.example.com/ns1' the default namespace for 'ns:item'? " . ($isPrefixedDefault2 ? 'Yes' : 'No') . "\n"; // 期待値: No
74
75    // $elementWithOtherDefaultNs ('otherItem') のデフォルト名前空間をチェックします。
76    // この要素は 'http://www.example.com/ns2' をデフォルト名前空間として宣言しています。
77    $isOtherItemDefault = $elementWithOtherDefaultNs->isDefaultNamespace('http://www.example.com/ns2');
78    echo "Is 'http://www.example.com/ns2' the default namespace for 'otherItem'? " . ($isOtherItemDefault ? 'Yes' : 'No') . "\n"; // 期待値: Yes
79}
80
81// サンプルコードを実行します。
82checkDefaultNamespaceExample();

PHP 8のDOMNode::isDefaultNamespaceメソッドは、XMLドキュメント内の特定の要素に対して、指定されたURIがその要素の「デフォルト名前空間」であるかを判定する際に利用されます。XML名前空間は、要素や属性名の衝突を避けるために使われる仕組みで、要素に明示的にプレフィックスが指定されていない場合に適用されるURIが「デフォルト名前空間」と呼ばれます。

このメソッドは、引数として検証したい名前空間のURIを文字列（string $namespaceURI）で受け取ります。そして、指定されたURIが対象の要素のデフォルト名前空間と一致すればtrueを、一致しなければfalseをブール値（bool）として返します。

サンプルコードでは、まず複数のXML要素を作成し、それぞれ異なる名前空間の指定方法を試しています。具体的には、名前空間を持たない要素、createElementNSでデフォルト名前空間を指定した要素、そしてプレフィックス付きで名前空間を指定した要素などが含まれます。isDefaultNamespaceの呼び出しでは、これらの要素に対して様々なURIを渡し、どのURIがデフォルト名前空間として認識されるかを確認しています。特に、プレフィックスが指定された要素は、たとえ名前空間URIが割り当てられていても、そのURIがデフォルト名前空間とはならない点が重要です。また、子要素が親要素のデフォルト名前空間を継承する挙動も確認できます。このメソッドを使うことで、XML文書の構造を正確に理解し、名前空間に基づいた処理を適切に実装できるようになります。

Copy
1<?php
2
3/**
4 * Dom\Entity::isDefaultNamespace メソッドの使用例を示します。
5 * この関数は、XML ドキュメント内のエンティティが特定の URI をデフォルトの名前空間として持っているかを確認します。
6 * XML のエンティティは、通常、要素や属性のように名前空間に直接関連付けられるものではないため、
7 * このメソッドはほとんどの場合 false を返します。
8 *
9 * @param string $xmlString 処理する XML 文字列
10 * @param string $entityName 確認するエンティティの名前
11 * @param string $namespaceURI 確認対象の名前空間 URI
12 * @return bool エンティティが指定された URI をデフォルトの名前空間として持つ場合に true、それ以外は false
13 */
14function checkEntityDefaultNamespace(string $xmlString, string $entityName, string $namespaceURI): bool
15{
16    // DOMDocument を初期化し、XML を読み込みます。
17    $dom = new DOMDocument();
18    $dom->loadXML($xmlString);
19
20    // ドキュメントタイプ (DTD) を取得します。
21    $doctype = $dom->doctype;
22
23    // DTD またはエンティティコレクションが存在しない場合、処理を中断します。
24    if (!$doctype || !$doctype->entities) {
25        echo "Warning: XML ドキュメントに DTD またはエンティティコレクションが見つかりませんでした。\n";
26        return false;
27    }
28
29    // 指定された名前のエンティティを取得します。
30    /** @var Dom\Entity|null $entity */
31    $entity = $doctype->entities->getNamedItem($entityName);
32
33    // エンティティが見つかった場合、isDefaultNamespace を呼び出します。
34    if ($entity) {
35        return $entity->isDefaultNamespace($namespaceURI);
36    }
37
38    echo "Warning: エンティティ '{$entityName}' が見つかりませんでした。\n";
39    return false;
40}
41
42// サンプル XML: 内部 DTD でエンティティを定義し、ルート要素にデフォルトの名前空間を設定します。
43// XML内の `xmlns` 属性が XML 名前空間を定義しています。
44$sampleXml = <<<XML
45<?xml version="1.0"?>
46<!DOCTYPE example [
47  <!ENTITY copyright "© 2023 Example Corp.">
48  <!ENTITY brand "ExampleBrand">
49]>
50<root xmlns="http://www.example.com/ns/default">
51  <p>This is &brand; &copyright;.</p>
52</root>
53XML;
54
55// ルート要素のデフォルト名前空間 URI
56$defaultNsUri = 'http://www.example.com/ns/default';
57// 無関係な名前空間 URI
58$otherNsUri = 'http://www.example.com/ns/other';
59
60// エンティティ 'copyright' がドキュメントのデフォルト名前空間を持つか確認します。
61echo "エンティティ 'copyright' が '{$defaultNsUri}' をデフォルト名前空間として持つか: ";
62var_dump(checkEntityDefaultNamespace($sampleXml, 'copyright', $defaultNsUri));
63
64// エンティティ 'brand' が別の名前空間を持つか確認します。
65echo "エンティティ 'brand' が '{$otherNsUri}' をデフォルト名前空間として持つか: ";
66var_dump(checkEntityDefaultNamespace($sampleXml, 'brand', $otherNsUri));
67
68// 存在しないエンティティをチェックした場合の動作を確認します。
69echo "エンティティ 'nonexistent' が '{$defaultNsUri}' をデフォルト名前空間として持つか: ";
70var_dump(checkEntityDefaultNamespace($sampleXml, 'nonexistent', $defaultNsUri));

PHP 8のDom\Entity::isDefaultNamespaceメソッドは、XMLドキュメント内の特定のエンティティが、指定されたURIをデフォルトの名前空間として持っているかを確認するために使用されます。このメソッドはDom\Entityクラスに属し、引数として検証したい名前空間URIを文字列$namespaceURIで受け取ります。戻り値は真偽値boolで、エンティティが指定されたURIをデフォルト名前空間として持つ場合はtrue、それ以外の場合はfalseが返されます。

しかし、XMLのエンティティ（例えば、<!ENTITY ...>で定義され、&entityName;のように参照されるもの）は、XML要素や属性とは異なり、直接的に名前空間に所属することはありません。そのため、このisDefaultNamespaceメソッドをエンティティに対して呼び出した場合、ほとんどのケースでfalseが返されるという点に注意が必要です。

提示されたサンプルコードでは、XML文字列からDOMDocumentオブジェクトを作成し、その中のDTD（文書型定義）からエンティティコレクションを取得しています。特定のエンティティを名前で検索した後、そのエンティティに対してisDefaultNamespaceメソッドを呼び出し、指定された名前空間URIがデフォルトであるかを確認しています。サンプルでは、ルート要素にはデフォルト名前空間が定義されていますが、エンティティ自体はそれに直接関連付けられないため、メソッドの呼び出し結果はすべてfalseとなっています。この挙動は、XMLにおけるエンティティと名前空間の基本的な関係性を理解する上で参考になります。