【PHP8.x】DOMEntityReference::namespaceURIプロパティの使い方

Copy
1<?php
2
3/**
4 * DOMEntityReferenceクラスのnamespaceURIプロパティの使用例。
5 *
6 * このプロパティは、XMLドキュメント内のエンティティ参照が属する名前空間のURIを返します。
7 * 一般的に、エンティティ参照自体が特定のXML名前空間に属することは稀であるため、
8 * このプロパティはほとんどの場合 `null` を返します。
9 *
10 * PHPのコードを構造化するための「namespace」キーワードとは異なり、
11 * ここでの「名前空間」はXML文書の要素や属性の命名衝突を避けるための概念です。
12 */
13function demonstrateDomEntityReferenceNamespaceURI(): void
14{
15    // DOMDocumentのインスタンスを作成
16    $dom = new DOMDocument();
17    $dom->preserveWhiteSpace = false; // 空白ノードを無視
18    $dom->formatOutput = true;      // 整形して出力
19
20    // カスタムエンティティを含むXML文字列を定義
21    // DTD (Document Type Definition) で 'myentity' を宣言し、XML内で参照します。
22    // これにより、DOMパーサーが '&myentity;' を DOMEntityReference ノードとして扱います。
23    $xmlString = <<<XML
24<!DOCTYPE root [
25  <!ENTITY myentity "My Custom Entity Text">
26]>
27<root>
28    <element attribute="value">&myentity;</element>
29    <example>&amp;</example>
30</root>
31XML;
32
33    // XMLをロードします。
34    // LIBXML_NOENT: エンティティ参照を展開せずにDOMツリー内に DOMEntityReference ノードとして残します。
35    // LIBXML_DTDLOAD: ドキュメントのDTDをロードし、内部エンティティを認識させます。
36    // LIBXML_DTDATTR: DTDで定義された属性のデフォルト値や型情報を適用します。
37    // これらのフラグがないと、&myentity; はパースエラーになるか、単なるテキストとして展開される場合があります。
38    if (!@$dom->loadXML($xmlString, LIBXML_NOENT | LIBXML_DTDLOAD | LIBXML_DTDATTR)) {
39        echo "XMLのロード中にエラーが発生しました。\n";
40        return;
41    }
42
43    echo "DOMEntityReference ノードを検索し、namespaceURIプロパティを表示します。\n";
44    echo "------------------------------------------------------------------\n";
45
46    // DOMツリーを走査し、DOMEntityReferenceノードを探します
47    foreach ($dom->getElementsByTagName('*') as $element) {
48        foreach ($element->childNodes as $childNode) {
49            // ノードがDOMEntityReference型であるかを確認
50            if ($childNode instanceof DOMEntityReference) {
51                echo "見つかったDOMEntityReferenceノード名: '{$childNode->nodeName}'\n";
52
53                // DOMEntityReference::namespaceURI プロパティにアクセス
54                // エンティティ参照が特定のXML名前空間に属していればそのURIを、そうでなければnullを返します。
55                $namespaceURI = $childNode->namespaceURI;
56
57                echo "  namespaceURI: " . ($namespaceURI ?? "null (このエンティティにはXML名前空間が関連付けられていません)") . "\n";
58            }
59        }
60    }
61
62    echo "------------------------------------------------------------------\n";
63    echo "注: '&amp;' のような標準的なHTML/XMLエンティティは、通常DOMEntityReferenceノードとして\n";
64    echo "    扱われず、直接文字 '&' として展開されるか、別の方法で処理されることが多いです。\n";
65    echo "    上記の例では '&myentity;' のようなカスタムエンティティが対象となります。\n";
66}
67
68// 関数を実行
69demonstrateDomEntityReferenceNamespaceURI();

DOMEntityReference::namespaceURIプロパティは、XMLドキュメント内のエンティティ参照が属するXML名前空間のURIを返します。このプロパティは引数を取りません。戻り値は?string型で、エンティティ参照が特定のXML名前空間に属していればそのURIを表す文字列を返しますが、関連するXML名前空間がなければnullを返します。

一般的に、XML文書内のエンティティ参照自体が特定のXML名前空間に直接属することは稀であるため、このプロパティの戻り値はほとんどの場合nullとなります。ここでいう「名前空間」は、XML文書内で要素や属性の名前の衝突を避けるための仕組みであり、PHPのコードを構造化する際に使用するnamespaceキーワードとは異なる概念である点にご注意ください。

サンプルコードでは、<!ENTITY>で定義したカスタムエンティティ（例: &myentity;）を含むXMLを読み込んでいます。LIBXML_NOENTフラグを使用することで、このエンティティ参照をDOMツリー内でDOMEntityReferenceノードとして認識させます。その後、このDOMEntityReferenceノードのnamespaceURIプロパティにアクセスし、通常はnullが返される挙動を確認することで、エンティティ参照が特定のXML名前空間を持たないことを示しています。

Copy
1<?php
2
3// [キーワード: php namespace use] PHPの名前空間を定義します。
4// これにより、このファイル内で定義されるクラスは 'App\DomExamples' という
5// 名前空間に所属することになり、他のコードとの名前の衝突を防ぎます。
6namespace App\DomExamples;
7
8// [キーワード: php namespace use] PHP標準のDOM拡張クラス (例: DOMDocument, DOMXPath) はグローバル名前空間に属しているため、
9// 'use' キーワードを使ってインポートする必要はありません。代わりに完全修飾名 (例: \DOMDocument) で指定します。
10// ここでは、キーワードの要件に沿って、このファイル内で独自のクラスを名前空間内に定義し、
11// それをスクリプトの実行部で 'use' キーワードを使って参照する例を示します。
12
13/**
14 * DOMEntityReference ノードの namespaceURI をチェックするクラス。
15 * システムエンジニアを目指す初心者のために、DOMツリーの操作とXMLの名前空間の概念を簡潔に示します。
16 */
17class EntityReferenceUriChecker
18{
19    /**
20     * XML文字列からDOMEntityReferenceノードを探し、その namespaceURI を返します。
21     *
22     * @param string $xmlString 処理するXML文字列。エンティティ参照を含む必要があります。
23     * @return string|null 見つかった最初のDOMEntityReferenceノードのnamespaceURI、
24     *                     またはエンティティ参照が見つからない場合は null を返します。
25     */
26    public function getEntityReferenceNamespaceURI(string $xmlString): ?string
27    {
28        // DOMDocument オブジェクトを作成します。
29        // PHP標準のクラスなので、グローバル名前空間を示す \ をプレフィックスとして付けます。
30        $dom = new \DOMDocument();
31
32        // [重要] エンティティ参照を展開しないように設定します。
33        // これにより、XMLドキュメント内で '&entity_name;' の形式で記述された部分が
34        // DOMEntityReference ノードとしてDOMツリーに保持されます。
35        // この設定がない場合、エンティティの内容が直接テキストとして展開され、
36        // DOMEntityReference ノードはツリーに現れません。
37        $dom->substituteEntities = false;
38
39        // XML文字列をロードします。エラーが発生した場合は @ 演算子で警告を抑制しています。
40        // 実運用では適切なエラーハンドリングを実装すべきです。
41        @$dom->loadXML($xmlString);
42
43        // DOMXPath オブジェクトを作成し、DOMツリー内を効率的に検索できるようにします。
44        $xpath = new \DOMXPath($dom);
45
46        // XPathクエリを使用して、ドキュメント内のすべてのエンティティ参照ノード (nodeType=7) を探します。
47        // DOMNode::nodeType が 7 (XML_ENTITY_REFERENCE_NODE) のノードを検索します。
48        $entityReferences = $xpath->query('//node()[nodeType() = 7]');
49
50        // エンティティ参照ノードが見つかった場合、最初のノードの namespaceURI を返します。
51        if ($entityReferences->length > 0) {
52            /** @var \DOMEntityReference $entityReference */
53            $entityReference = $entityReferences->item(0);
54            return $entityReference->namespaceURI;
55        }
56
57        // エンティティ参照ノードが見つからなかった場合は null を返します。
58        return null;
59    }
60}
61
62// [キーワード: php namespace use] PHPの名前空間内で定義されたクラスを
63// 現在のスコープで利用するために 'use' キーワードを使用します。
64// これにより、'App\DomExamples\EntityReferenceUriChecker' を 'EntityReferenceUriChecker' として
65// 短縮名で参照できるようになります。
66use App\DomExamples\EntityReferenceUriChecker;
67
68// -----------------------------------------------------------------------------
69// クラスの使用例
70// -----------------------------------------------------------------------------
71
72// エンティティ参照を含むXML文字列を定義します。
73// <!DOCTYPE>宣言でエンティティ 'myentity' を定義し、
74// <element>内で '&myentity;' として参照しています。
75$xmlWithEntityRef = <<<XML
76<?xml version="1.0" encoding="UTF-8"?>
77<!DOCTYPE doc [
78  <!ENTITY myentity "Hello, World!">
79]>
80<root>
81  <element attr="test">&myentity;</element>
82</root>
83XML;
84
85// EntityReferenceUriChecker クラスのインスタンスを作成します。
86$checker = new EntityReferenceUriChecker();
87
88// メソッドを呼び出して、エンティティ参照の namespaceURI を取得します。
89$uri = $checker->getEntityReferenceNamespaceURI($xmlWithEntityRef);
90
91// 結果を出力します。
92// DOMEntityReference::namespaceURI は、ほとんどの場合 null を返します。
93// これは、エンティティ参照ノード自体がXMLの名前空間に直接属さないためです。
94echo "XML with entity reference:\n";
95echo "  DOMEntityReference::namespaceURI: " . var_export($uri, true) . "\n";
96echo "  (ほとんどの場合 NULL になります。エンティティ参照ノード自体はXML名前空間に属しません。)\n\n";
97
98// -----------------------------------------------------------------------------
99
100// エンティティ参照を含まないXML文字列の例
101$xmlWithoutEntityRef = <<<XML
102<?xml version="1.0" encoding="UTF-8"?>
103<root>
104  <element attr="test">No entity here</element>
105</root>
106XML;
107
108$uriWithoutEntity = $checker->getEntityReferenceNamespaceURI($xmlWithoutEntityRef);
109
110echo "XML without entity reference:\n";
111echo "  DOMEntityReference::namespaceURI: " . var_export($uriWithoutEntity, true) . "\n";
112echo "  (XML文字列にエンティティ参照が見つからないため NULL になります。)\n";

PHPのDOMEntityReference::namespaceURIプロパティは、XMLドキュメント内のエンティティ参照ノードが属する名前空間のURIを取得するために使用されます。このプロパティには引数がなく、戻り値は文字列またはnullとなります。

サンプルコードでは、DOMDocument::substituteEntitiesプロパティをfalseに設定することで、XMLドキュメント内のエンティティ参照（例えば&myentity;）がDOMEntityReferenceノードとしてDOMツリーに保持されるようにしています。この設定がないと、エンティティの内容が直接展開され、DOMEntityReferenceノードは生成されません。その後、XPathクエリを用いてドキュメントからDOMEntityReferenceノードを検索し、見つかったノードのnamespaceURIを取得しています。

重要な点として、DOMEntityReferenceノード自体はXMLの名前空間に直接属さないため、このnamespaceURIプロパティはほとんどの場合nullを返します。これは、エンティティ参照が特定の名前空間に結びつくのではなく、XMLドキュメント全体で定義されるためです。

また、サンプルコードの冒頭では、namespace App\DomExamples;でクラスを特定の名前空間に定義し、スクリプトの実行部ではuse App\DomExamples\EntityReferenceUriChecker;と記述することで、そのクラスを短い名前で利用しています。これは、PHPでコードを整理し、他のコードとの名前の衝突を防ぐための基本的な仕組みです。