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

Copy
1<?php
2
3// このサンプルコードは、XML ドキュメントの DTD に定義されたエンティティ (Dom\Entity) を通じて、
4// 名前空間プレフィックスに対応するURIを検索する方法を示します。
5// 名前空間はXMLドキュメントのルート要素で定義されており、Dom\Entity はそのスコープ内で名前空間を解決します。
6
7// XML ドキュメントを定義します。
8// ルート要素 <root> には、デフォルトの名前空間 (xmlns) とプレフィックス付きの名前空間 (xmlns:pref) が定義されています。
9// DTD 内で、エンティティ 'myentity' が定義されています。
10$xmlString = <<<XML
11<?xml version="1.0" encoding="UTF-8"?>
12<!DOCTYPE root [
13    <!ENTITY myentity "This is an example entity.">
14]>
15<root xmlns="http://example.com/default-namespace" xmlns:pref="http://example.com/prefixed-namespace">
16    <child/>
17</root>
18XML;
19
20// DOMDocument オブジェクトを作成し、上記のXML文字列を読み込みます。
21$dom = new DOMDocument();
22// XMLの検証エラーを無視してDTDをロードするために、true を渡すこともありますが、
23// 今回はDTDがシンプルなので、デフォルトの false で問題ありません。
24$dom->loadXML($xmlString);
25
26// XMLドキュメントの DOCTYPE (DTD) ノードを取得します。
27$doctype = $dom->doctype;
28
29// DOCTYPE が存在するか確認します。
30if ($doctype) {
31    // DTD に定義されたエンティティのコレクションから、名前が 'myentity' のエンティティを取得します。
32    // Dom\Entity クラスのインスタンスは DOMNode を継承しており、lookupNamespaceURI メソッドを持ちます。
33    $entity = $doctype->entities->getNamedItem('myentity');
34
35    // Dom\Entity インスタンスが正しく取得できたか確認します。
36    if ($entity instanceof Dom\Entity) {
37        echo "Dom\Entity::lookupNamespaceURI メソッドのテスト:\n";
38
39        // 1. プレフィックス 'pref' に対応する名前空間URIを検索します。
40        // このURIはXMLのルート要素で定義されています。
41        $namespaceURI_pref = $entity->lookupNamespaceURI('pref');
42        echo "  プレフィックス 'pref' の名前空間URI: " . ($namespaceURI_pref ?? "見つかりませんでした") . "\n";
43
44        // 2. デフォルトの名前空間URIを検索します。（プレフィックスは null または空文字列）
45        // このURIもXMLのルート要素で定義されています。
46        $namespaceURI_default = $entity->lookupNamespaceURI(null);
47        echo "  デフォルトの名前空間URI: " . ($namespaceURI_default ?? "見つかりませんでした") . "\n";
48
49        // 3. 存在しないプレフィックス 'nonexistent' に対応する名前空間URIを検索します。
50        // これは見つからないため、null が返されます。
51        $namespaceURI_nonexistent = $entity->lookupNamespaceURI('nonexistent');
52        echo "  プレフィックス 'nonexistent' の名前空間URI: " . ($namespaceURI_nonexistent ?? "見つかりませんでした") . "\n";
53    } else {
54        echo "エラー: エンティティ 'myentity' が見つかりませんでした。\n";
55    }
56} else {
57    echo "エラー: XMLドキュメントに DOCTYPE が見つかりませんでした。\n";
58}
59

PHPのDom\Entity::lookupNamespaceURIメソッドは、XMLドキュメントのDTDに定義されたエンティティ (Dom\Entityオブジェクト) を使って、特定の名前空間プレフィックスに対応するURI (Uniform Resource Identifier) を検索する際に利用されます。このメソッドは、エンティティ自身が名前空間を定義するわけではなく、そのエンティティが存在するXMLドキュメント全体のスコープ、特にXMLのルート要素などで定義された名前空間の情報を参照して解決を行います。

引数$prefixには、検索したい名前空間のプレフィックスを文字列で指定します。もしXMLドキュメントのデフォルトの名前空間 (プレフィックスが指定されていない名前空間) を調べたい場合は、nullまたは空文字列を渡します。メソッドの戻り値は、対応する名前空間URIが見つかればそのURIを文字列として返しますが、指定されたプレフィックスに対応する名前空間が見つからない場合はnullを返します。

サンプルコードでは、ルート要素に名前空間を定義したXMLドキュメントを用意し、そこからDOMDocumentを通じてDTD内のmyentityというエンティティを取得します。このDom\Entityインスタンスに対してlookupNamespaceURIメソッドを適用することで、プレフィックス「pref」に対するURIやデフォルトの名前空間URIが正しく取得できることを示しています。また、存在しないプレフィックスを渡すとnullが返される挙動も確認できます。このように、XMLドキュメント内の名前空間をエンティティのコンテキストから解決する際に役立つメソッドです。

Copy
1<?php
2
3use Dom\Document;
4use Dom\Entity;
5
6/**
7 * Dom\Entity::lookupNamespaceURI メソッドの使用例。
8 *
9 * この関数は、XMLドキュメントからDTDエンティティを取得し、
10 * そのエンティティのコンテキストで指定されたプレフィックスに対する
11 * 名前空間URIの検索を試みます。
12 *
13 * DTDエンティティは通常XML名前空間とは直接関連しないため、
14 * このメソッドはほとんどの場合 null を返します。
15 * これは、指定されたプレフィックスに対応する名前空間URIが
16 * 「見つからない」状況を示す典型的な例となります。
17 *
18 * @param string $prefix 検索する名前空間プレフィックス
19 * @return void
20 */
21function demonstrateDomEntityNamespaceLookup(string $prefix = 'example')
22{
23    // DTDエンティティを含むシンプルなXMLドキュメントを作成します。
24    // 'myent' という名前のエンティティが定義されています。
25    $xmlString = <<<XML
26<!DOCTYPE root [
27  <!ENTITY myent "Entity Content">
28]>
29<root>Hello &myent; World!</root>
30XML;
31
32    $dom = new Document();
33    $dom->loadXML($xmlString);
34
35    // ドキュメントのDTDから'myent'エンティティを取得します。
36    // Dom\DocumentType::entities は Dom\NamedNodeMap を返し、
37    // その中から getNamedItem() で Dom\Entity インスタンスを取得できます。
38    /** @var Dom\Entity|null $entity */
39    $entity = $dom->doctype?->entities?->getNamedItem('myent');
40
41    if ($entity === null) {
42        echo "エラー: 'myent' エンティティが見つかりませんでした。\n";
43        return;
44    }
45
46    echo "Dom\\Entity のノード名: " . $entity->nodeName . "\n";
47
48    // Dom\Entity::lookupNamespaceURI メソッドを呼び出します。
49    // DTDエンティティはXML名前空間とは異なる目的で使用されるため、
50    // 通常、エンティティ自体に関連付けられた名前空間はありません。
51    // そのため、このメソッドは指定されたプレフィックスに対応する
52    // 名前空間URIを見つけられず、null を返します。
53    $namespaceURI = $entity->lookupNamespaceURI($prefix);
54
55    if ($namespaceURI === null) {
56        echo sprintf(
57            "結果: プレフィックス '%s' に対応する名前空間URIは、Dom\\Entity '%s' のコンテキストで見つかりませんでした (null が返されました)。\n",
58            $prefix,
59            $entity->nodeName
60        );
61        echo "これは、DTDエンティティが名前空間に関連付けられていないか、"
62             . "指定されたプレフィックスが現在のスコープ内で定義されていないことを意味します。\n";
63    } else {
64        echo sprintf(
65            "結果: プレフィックス '%s' に対応する名前空間URI: %s\n",
66            $prefix,
67            $namespaceURI
68        );
69        echo "注意: DTDエンティティに対して名前空間URIが見つかることは非常に稀です。\n";
70    }
71}
72
73// 存在しないプレフィックスで検索を試みます
74demonstrateDomEntityNamespaceLookup('unknown');
75echo "\n";
76
77// XML標準のプレフィックス ('xml') で検索を試みます
78// DTDエンティティのコンテキストでは、これも通常見つかりません。
79demonstrateDomEntityNamespaceLookup('xml');

「Dom\Entity::lookupNamespaceURI」メソッドは、XMLドキュメントのDTDエンティティのコンテキスト内で、指定された名前空間プレフィックス（$prefix）に対応するURIを検索する目的で使用されます。引数$prefixには検索したいプレフィックスを文字列で渡し、戻り値は対応するURIの文字列、または見つからなかった場合にnullを返します。

しかし、DTDエンティティはXMLの名前空間とは異なる用途で定義されるため、通常、エンティティ自体には名前空間が関連付けられていません。そのため、このメソッドをDom\Entityインスタンスに対して呼び出すと、ほとんどのケースで指定されたプレフィックスに対応する名前空間URIが見つからず、戻り値としてnullが返されます。

このサンプルコードでは、DTDエンティティ「myent」を取得し、「unknown」や「xml」といったプレフィックスでlookupNamespaceURIを試しています。期待通り、どちらのケースでもnullが返され、DTDエンティティのコンテキストでは名前空間URIが「見つからない」状況が示されています。これは、特定の要素に関連付けられた名前空間が見つからない場合の典型的な挙動を理解する上で役立ちます。