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

Copy
1<?php
2
3// Dom\Entity::lookupPrefix() メソッドの使用例
4// Dom\Entity クラスは、XMLのDTD (Document Type Definition) で宣言されたエンティティを表します。
5// lookupPrefix() メソッドは、Dom\Node クラスから継承されており、
6// 指定された名前空間URIに対応するプレフィックスを、現在のノードのスコープで検索します。
7// しかし、Dom\Entity オブジェクト自体はDTD宣言の一部であり、XMLツリー内の要素のように
8// 直接的な名前空間スコープを持たないため、このメソッドは通常 null を返します。
9
10/**
11 * Dom\Entity の lookupPrefix メソッドのサンプルを示します。
12 * このメソッドは、DTDエンティティが名前空間スコープを持たないため、通常は null を返します。
13 */
14function demonstrateDomEntityLookupPrefix(): void
15{
16    // XML ドキュメントを作成します。
17    // 内部サブセットでDOCTYPEとエンティティを定義し、名前空間を含むエンティティを作成します。
18    $dom = new Dom\Document();
19    $dom->loadXML(<<<XML
20<!DOCTYPE doc [
21  <!ENTITY my_ns_entity "<root xmlns:ex='http://example.com/ns'><ex:item/></root>">
22  <!ENTITY my_simple_entity "Just a simple text entity.">
23]>
24<doc/>
25XML);
26
27    // ドキュメントタイプ (DOCTYPE) オブジェクトを取得します。
28    $documentType = $dom->doctype;
29
30    if ($documentType === null) {
31        echo "エラー: DOCTYPE が見つかりませんでした。\n";
32        return;
33    }
34
35    // ドキュメントタイプからエンティティの NamedNodeMap を取得します。
36    $entities = $documentType->entities;
37
38    // 特定のエンティティ (Dom\Entity オブジェクト) を名前で取得します。
39    // ここでは、名前空間を含むコンテンツを持つ "my_ns_entity" を例にとります。
40    $entity = $entities->getNamedItem('my_ns_entity');
41
42    if ($entity instanceof Dom\Entity) {
43        echo "Dom\\Entity 'my_ns_entity' が見つかりました。\n";
44
45        // 検索したい名前空間 URI を指定します。
46        $namespaceUriToLookup = 'http://example.com/ns';
47
48        // lookupPrefix メソッドを呼び出します。
49        // Dom\Entity は DTD の宣言自体を表すため、XMLツリー内のノードのような
50        // 名前空間スコープを持たず、通常は指定された名前空間 URI に対応する
51        // プレフィックスは見つかりません (null が返されます)。
52        $prefix = $entity->lookupPrefix($namespaceUriToLookup);
53
54        echo "名前空間 URI '{$namespaceUriToLookup}' のプレフィックス: ";
55        if ($prefix !== null) {
56            echo "'{$prefix}'\n";
57        } else {
58            echo "見つかりませんでした (null)\n";
59        }
60
61    } else {
62        echo "Dom\\Entity 'my_ns_entity' が見つかりませんでした。\n";
63    }
64
65    // 別のエンティティ (テキストのみ) で試します。
66    $simpleEntity = $entities->getNamedItem('my_simple_entity');
67    if ($simpleEntity instanceof Dom\Entity) {
68        echo "\nDom\\Entity 'my_simple_entity' が見つかりました。\n";
69        $namespaceUriToLookup = 'http://example.com/ns';
70        $prefix = $simpleEntity->lookupPrefix($namespaceUriToLookup);
71        echo "名前空間 URI '{$namespaceUriToLookup}' のプレフィックス: ";
72        if ($prefix !== null) {
73            echo "'{$prefix}'\n";
74        } else {
75            echo "見つかりませんでした (null)\n";
76        }
77    }
78}
79
80// サンプル関数を実行します。
81demonstrateDomEntityLookupPrefix();
82
83?>

PHP 8のDom\Entity::lookupPrefix()メソッドは、XMLのDTD（Document Type Definition）で宣言されたエンティティを表すDom\Entityクラスの機能です。このメソッドは、第一引数string $namespaceで指定された名前空間URIに対応するプレフィックスを検索し、そのstring値を返します。対応するプレフィックスが見つからない場合はnullを返します。

Dom\EntityオブジェクトはXMLツリー内の要素とは異なり、DTDの宣言そのものを表します。そのため、名前空間スコープを直接持っていません。この特性から、Dom\Entityに対してlookupPrefix()メソッドを呼び出した場合、通常は指定された名前空間URIに対応するプレフィックスは見つからず、戻り値としてnullが返される挙動を示します。

サンプルコードでは、内部サブセットに名前空間を含むエンティティを定義したXMLドキュメントを作成し、そこからDom\Entityオブジェクトを取得しています。そして、特定の名前空間URIを指定してlookupPrefix()メソッドを呼び出し、その結果がnullとなることを確認しています。この例は、Dom\Entityが名前空間を解決する文脈を持たないという性質を理解するのに役立ちます。

Copy
1<?php
2
3/**
4 * この関数は、PHP DOM拡張のDom\Entity::lookupPrefixメソッドの使用例と、
5 * JavaScriptのlocation.searchに相当するURLクエリパラメータのPHPでの取得方法をデモンストレーションします。
6 *
7 * Dom\EntityはDTDエンティティを表し、lookupPrefixメソッドは継承元のDOMNode::lookupPrefixを呼び出します。
8 * DTDエンティティ自体は通常、直接名前空間を宣言しないため、このメソッドはnullを返すことがほとんどです。
9 * このサンプルは、リファレンスのメソッド呼び出しと、キーワードとの関連性を示すためのものです。
10 *
11 * @param string $entityName 検索対象のDTDエンティティ名 (例: 'myentity')
12 * @return void
13 */
14function demonstrateDomEntityLookupPrefix(string $entityName = 'myentity'): void
15{
16    // キーワード "location.search" に関連する部分。
17    // PHPでは、URLのクエリパラメータは `$_GET` スーパーグローバルでアクセスできます。
18    // ここでは、検索する名前空間URIのベースをクエリパラメータから取得します。
19    // 例: スクリプトを `http://localhost/script.php?namespace_base=http://custom.org/ns/` のように呼び出します。
20    $namespaceBase = $_GET['namespace_base'] ?? 'http://default.org/ns/';
21
22    // 完全な名前空間URIを構築します。
23    $targetNamespace = $namespaceBase . 'example';
24
25    // DTDエンティティと、名前空間を宣言した要素を含むXML文字列を定義します。
26    // 注意: DTDエンティティは通常、名前空間プレフィックスを直接持ちません。
27    // そのため、lookupPrefixはほとんどの場合nullを返します。
28    $xmlString = <<<XML
29<!DOCTYPE doc [
30  <!ENTITY myentity "Hello, World!">
31]>
32<doc xmlns:ex="$targetNamespace">
33  <data>&myentity;</data>
34</doc>
35XML;
36
37    $dom = new DOMDocument();
38    // XMLをロードし、DTDを読み込むためのオプションを指定します。
39    // LIBXML_NOENT はエンティティ参照を展開します。LIBXML_DTDLOAD はDTDをロードします。
40    $dom->loadXML($xmlString, LIBXML_NOENT | LIBXML_DTDLOAD);
41
42    // ドキュメントタイプからDTDエンティティを取得します。
43    // PHP 8.1以降のリファレンスではDom\Entityと表記されますが、
44    // 実装としてはグローバル名前空間のDOMEntityクラスが使われます。
45    $entity = $dom->doctype?->entities?->getNamedItem($entityName);
46
47    if ($entity instanceof DOMEntity) {
48        echo "検索対象エンティティ: '{$entity->nodeName}'\n";
49        echo "ターゲット名前空間URI: '{$targetNamespace}'\n";
50
51        // Dom\Entity (DOMEntity) クラスのlookupPrefixメソッドを呼び出します。
52        // このメソッドはDOMNodeから継承されており、指定された名前空間URIに対応するプレフィックスを検索します。
53        // DTDエンティティノード自体は名前空間宣言を持たないため、通常はnullを返します。
54        $prefix = $entity->lookupPrefix($targetNamespace);
55
56        if ($prefix !== null) {
57            echo "名前空間URI '{$targetNamespace}' に対応するプレフィックス: '{$prefix}'\n";
58        } else {
59            echo "名前空間URI '{$targetNamespace}' に対応するプレフィックスは見つかりませんでした。\n";
60            echo "（DTDエンティティノードは通常、直接名前空間を宣言しません）\n";
61        }
62    } else {
63        echo "エンティティ '{$entityName}' が見つかりませんでした。\n";
64    }
65}
66
67// 単体で動作可能なように関数を呼び出します。
68// 例: ブラウザでアクセスする場合
69//    http://localhost/your_script.php
70//    http://localhost/your_script.php?namespace_base=http://custom.org/ns/
71demonstrateDomEntityLookupPrefix('myentity');
72

このサンプルコードは、PHP 8のDom\Entity::lookupPrefixメソッドの使用方法と、JavaScriptのlocation.searchに相当するURLクエリパラメータのPHPでの取得方法を説明しています。

JavaScriptのlocation.searchはURLのクエリパラメータ部分を取得しますが、PHPでは$_GETスーパーグローバル変数を用いて同様にURLクエリパラメータを取得できます。このサンプルでは、$_GET['namespace_base']からURLで指定された名前空間のベースURIを取得しています。

Dom\Entity::lookupPrefixメソッドは、指定された名前空間URIに対応するプレフィックスを検索します。引数$namespaceには検索対象の名前空間URIを渡し、戻り値は、対応するプレフィックスが見つかればその文字列、見つからなければnullとなります。Dom\EntityはDTDエンティティを扱うクラスですが、DTDエンティティ自体は通常、直接名前空間を宣言しません。このため、このメソッドがDom\Entityインスタンスに対して呼び出された場合、ほとんどのケースでnullを返します。

このサンプルコードは、このような特性を持つDom\Entity::lookupPrefixの呼び出し方と、URLクエリパラメータのPHPでの扱いを実践的に示しています。