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

Copy
1<?php
2
3/**
4 * Dom\EntityReference::isDefaultNamespace メソッドのサンプルコード
5 *
6 * PHP 8において、Dom\EntityReference オブジェクトは通常、
7 * XMLドキュメントの解析時にエンティティが展開されるため、
8 * DOMツリーに直接生成されることは稀です。
9 * また、Dom\Document::createEntityReference() メソッドもPHP 8の新しいDOM拡張では削除されています。
10 * そのため、Dom\EntityReference のインスタンスを標準的な方法で取得することは非常に困難です。
11 *
12 * ここでは、Dom\EntityReference の isDefaultNamespace メソッドの呼び出し構文と、
13 * その名前空間判定の概念をデモンストレーションするために、
14 * 古いDOM API (DOMDocument::createEntityReference) を用いて一時的にDOMEntityReferenceオブジェクトを生成し、
15 * それをPHP 8のDom\EntityReference型として利用する特殊な方法を採用します。
16 *
17 * **注意**: この方法は、実際のアプリケーションで Dom\EntityReference オブジェクトを
18 * 取得する一般的な方法を示すものではありません。
19 * 生成されたオブジェクトはDOMツリーに属さないため、名前空間の解決は期待通りに機能せず、
20 * isDefaultNamespace は常に false を返します。
21 * このメソッドの真の動作を確認するには、Dom\Element::isDefaultNamespace などを参照してください。
22 */
23
24/**
25 * Dom\EntityReference のインスタンスを擬似的に取得する関数
26 *
27 * PHP 8ではDom\EntityReferenceを直接生成または取得する標準的な方法がないため、
28 * 後方互換性のある古いDOMAPI (DOMDocument::createEntityReference) を利用して
29 * DOMEntityReferenceオブジェクトを生成し、それをDom\EntityReferenceとして扱います。
30 * これにより、isDefaultNamespaceメソッドを呼び出すことが可能になります。
31 *
32 * @return Dom\EntityReference DOMEntityReferenceのインスタンス
33 */
34function getPseudoDomEntityReferenceInstance(): Dom\EntityReference
35{
36    // DOMDocument (古いクラス) を使用して DOMEntityReference を作成
37    $oldDom = new DOMDocument();
38    // 'exampleEntity' という名前のエンティティ参照オブジェクトを作成
39    $oldEntityRef = $oldDom->createEntityReference('exampleEntity');
40
41    // PHP 8のDom\EntityReferenceクラスは、旧DOMEntityReferenceとメソッドレベルで互換性があるため、
42    // 型ヒントをDom\EntityReferenceとすることで、メソッド呼び出しが可能になります。
43    // ただし、このオブジェクトはDOMツリーに属していないため、名前空間のコンテキストは持ちません。
44    return $oldEntityRef;
45}
46
47/**
48 * Dom\EntityReference::isDefaultNamespace メソッドの動作をデモンストレーションする関数
49 */
50function demonstrateEntityReferenceIsDefaultNamespace(): void
51{
52    // Dom\EntityReference のインスタンスを擬似的に取得
53    $entityRef = getPseudoDomEntityReferenceInstance();
54
55    // デモンストレーション用の名前空間URI
56    $defaultNamespaceUri = 'http://www.example.com/default';
57    $anotherNamespaceUri = 'http://www.example.com/another';
58
59    echo "--- Dom\\EntityReference::isDefaultNamespace デモンストレーション ---\n";
60
61    // isDefaultNamespaceを呼び出し
62    // 取得した $entityRef はDOMツリーに属していないため、名前空間のコンテキストを持ちません。
63    // そのため、これらの呼び出しは常に false を返します。
64    // この挙動は、Dom\Node::isDefaultNamespace の仕様によるもので、
65    // ノードがDOMツリーに存在し、有効な名前空間コンテキストを持つ場合にのみ意味があります。
66
67    $isDefaultMatch = $entityRef->isDefaultNamespace($defaultNamespaceUri);
68    echo "URI '{$defaultNamespaceUri}' はデフォルト名前空間か？: " . ($isDefaultMatch ? 'はい' : 'いいえ') . "\n";
69
70    $isDefaultMismatch = $entityRef->isDefaultNamespace($anotherNamespaceUri);
71    echo "URI '{$anotherNamespaceUri}' はデフォルト名前空間か？: " . ($isDefaultMismatch ? 'はい' : 'いいえ') . "\n";
72
73    $isDefaultEmpty = $entityRef->isDefaultNamespace('');
74    echo "URI '' (空) はデフォルト名前空間か？: " . ($isDefaultEmpty ? 'はい' : 'いいえ') . "\n";
75
76    echo "\n[補足]\n";
77    echo "上記の結果がすべて 'いいえ' となるのは、'getPseudoDomEntityReferenceInstance()'\n";
78    echo "で生成されたオブジェクトがどのDom\\Documentにも追加されておらず、\n";
79    echo "名前空間のコンテキストを持たないためです。\n";
80    echo "isDefaultNamespace() メソッドは、ノードがDOMツリーに存在し、\n";
81    echo "親要素からデフォルト名前空間のコンテキストを継承している場合に有効な結果を返します。\n";
82}
83
84// サンプルコードの実行
85demonstrateEntityReferenceIsDefaultNamespace();

PHP 8のDom\EntityReference::isDefaultNamespaceメソッドは、引数$uriで指定された名前空間URIが、そのノードのデフォルト名前空間と一致するかを判定します。戻り値は一致すればtrue、そうでなければfalseの真偽値（bool）です。

Dom\EntityReferenceオブジェクトは通常、XML解析時にエンティティが展開される際に内部的に扱われるため、開発者が直接操作することは稀です。サンプルコードはメソッドの呼び出し構文を示すためオブジェクトを生成していますが、これは実際のDOMツリーに属していません。

そのため、名前空間のコンテキストを持たないこのオブジェクトに対してisDefaultNamespaceメソッドを呼び出しても、常にfalseを返します。このメソッドは、ノードがDOMツリー内で有効な名前空間コンテキストを持つ場合にのみ、期待通りの判定結果を返します。実際の動作を確認するには、DOMツリーに属する要素ノードなどで試す必要があります。

Copy
1<?php
2
3/**
4 * Dom\EntityReference::isDefaultNamespace メソッドの動作を示すサンプルコードです。
5 *
6 * このメソッドは、指定されたURIがノードのコンテキストにおけるデフォルト名前空間であるかどうか、
7 * またはノード自身の名前空間URIがデフォルト名前空間であるかどうかを判定します。
8 * Dom\EntityReference ノード自体は名前空間を持たないため、引数なしの場合と引数ありの場合で
9 * 親要素やドキュメントのコンテキストにおけるデフォルト名前空間の定義が考慮されます。
10 *
11 * 注意: このサンプルコードは PHP 8.3 以降で利用可能な新しい DOM 拡張 (php-dom-standard) の
12 * Dom\Document および Dom\EntityReference クラスを使用しています。
13 * 従来の DOM 拡張 (DOMDocument, DOMEntityReference) とはクラス名が異なります。
14 */
15function demoEntityReferenceIsDefaultNamespace(): void
16{
17    // テスト用のXMLドキュメントを作成
18    // DTDでエンティティを定義し、ルート要素でデフォルト名前空間を設定します。
19    $xmlString = <<<XML
20<?xml version="1.0"?>
21<!DOCTYPE root [
22  <!ENTITY hello "Hello, XML!">
23]>
24<root xmlns="http://example.com/default" xmlns:p="http://example.com/prefixed">
25    <message>&hello;</message>
26    <p:another-message>Content with prefix</p:another-message>
27</root>
28XML;
29
30    // Dom\Document クラスを使用してXMLをロード
31    $document = new Dom\Document();
32    $document->loadXML($xmlString);
33
34    // Dom\EntityReference ノードをXMLツリーから検索して取得
35    // エンティティ参照ノードは直接名前空間を定義しないため、
36    // そのノードが存在するコンテキスト（親要素など）の名前空間定義が重要になります。
37    $entityRefNode = null;
38    foreach ($document->getElementsByTagName('*') as $element) {
39        foreach ($element->childNodes as $childNode) {
40            if ($childNode instanceof Dom\EntityReference) {
41                $entityRefNode = $childNode;
42                break 2; // エンティティ参照ノードが見つかったらループを終了
43            }
44        }
45    }
46
47    if ($entityRefNode === null) {
48        echo "エラー: XMLドキュメントから Dom\\EntityReference ノードが見つかりませんでした。\n";
49        return;
50    }
51
52    echo "Dom\\EntityReference::isDefaultNamespace() のデモ:\n";
53    echo "---------------------------------------------------\n";
54
55    // ケース 1: 引数なしで呼び出す場合
56    // 引数なしの場合、このメソッドはノード自身の名前空間URIがデフォルト名前空間であるかをチェックします。
57    // Dom\EntityReference ノード自体は名前空間URIを持たない（空文字列）ため、
58    // 通常は false が返されます。
59    $isDefaultWithoutUri = $entityRefNode->isDefaultNamespace();
60    echo "1. 引数なし (ノード自身の名前空間URIをチェック): " . ($isDefaultWithoutUri ? 'true' : 'false') . "\n";
61    echo "   -> Dom\\EntityReferenceノードは自身で名前空間URIを持たないため、false となります。\n\n";
62
63    // ケース 2: ドキュメントのデフォルト名前空間URIを指定してチェック
64    // このノードが存在するXMLコンテキスト（この場合は親要素 <message> および <root>）において、
65    // 指定されたURIがデフォルト名前空間として定義されているかを判定します。
66    $defaultNsUri = 'http://example.com/default';
67    $isDefaultWithDefaultUri = $entityRefNode->isDefaultNamespace($defaultNsUri);
68    echo "2. ドキュメントのデフォルト名前空間URI ('{$defaultNsUri}') でチェック: " . ($isDefaultWithDefaultUri ? 'true' : 'false') . "\n";
69    echo "   -> このURIがノードが存在するスコープでデフォルト名前空間として定義されているため、true となります。\n\n";
70
71    // ケース 3: 別の名前空間URIを指定してチェック
72    // このURIは、ノードのコンテキストにおけるデフォルト名前空間ではないため、false が返されます。
73    $otherNsUri = 'http://example.com/prefixed';
74    $isDefaultWithOtherUri = $entityRefNode->isDefaultNamespace($otherNsUri);
75    echo "3. 別の名前空間URI ('{$otherNsUri}') でチェック: " . ($isDefaultWithOtherUri ? 'true' : 'false') . "\n";
76    echo "   -> このURIはデフォルト名前空間ではないため、false となります。\n\n";
77
78    // ケース 4: 存在しない名前空間URIを指定してチェック
79    $nonExistentUri = 'http://example.com/nonexistent';
80    $isDefaultWithNonExistentUri = $entityRefNode->isDefaultNamespace($nonExistentUri);
81    echo "4. 存在しない名前空間URI ('{$nonExistentUri}') でチェック: " . ($isDefaultWithNonExistentUri ? 'true' : 'false') . "\n";
82    echo "   -> このURIはデフォルト名前空間ではないため、false となります。\n\n";
83}
84
85// サンプル関数を実行
86demoEntityReferenceIsDefaultNamespace();

Dom\EntityReference::isDefaultNamespaceメソッドは、PHP 8.3以降で利用可能な新しいDOM拡張に属し、XMLドキュメント内のノードが持つ名前空間に関する情報を取得する際に使用されます。このメソッドは、指定されたURIが対象ノードのコンテキスト（周囲の要素）においてデフォルト名前空間であるかどうかを判定し、結果を真偽値（bool）で返します。

引数?string $uriはオプションで、確認したい名前空間URIを指定します。この引数を省略した場合、メソッドはノード自身の名前空間URIがデフォルトであるかをチェックします。しかし、Dom\EntityReferenceノード自体は直接名前空間URIを持たないため、引数なしで呼び出すと通常はfalseが返されます。

サンプルコードでは、デフォルト名前空間http://example.com/defaultが定義されたXMLドキュメントからエンティティ参照ノードを取得しています。このノード自体は名前空間を持ちませんが、その親要素やドキュメント全体の名前空間定義がコンテキストとして考慮されます。

コードの実行結果は、引数なしの場合にfalseとなること、そして親要素で定義されているデフォルト名前空間URIを引数に指定した場合にtrueが返されることを示しています。これは、エンティティ参照ノードが自身の名前空間を持たず、その周囲のコンテキストの名前空間定義を継承して判定が行われるためです。他のURIを指定した場合はfalseが返されます。このメソッドは、XMLの名前空間定義をプログラムで確認する際に役立ちます。