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

Copy
1<?php
2
3/**
4 * DOMEntityReference::ownerDocument プロパティと DOMDocument::saveHTML() メソッドの利用例。
5 *
6 * この関数は、カスタムエンティティ参照を含むXMLドキュメントをロードし、
7 * ドキュメント内のDOMEntityReferenceノードを検索します。
8 * そのノードが属するDOMDocumentオブジェクト (ownerDocument) を取得し、
9 * 最後にドキュメント全体の内容をHTML形式で出力します。
10 */
11function demonstrateDomEntityReferenceOwnerDocument(): void
12{
13    // 1. DOMDocument オブジェクトを作成します。
14    // 出力を見やすくするため、空白とフォーマットの設定を行います。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    $dom->preserveWhiteSpace = false;
17    $dom->formatOutput = true;
18
19    // 2. カスタムエンティティ参照を含むXMLコンテンツを定義します。
20    // <!DOCTYPE ...> 内で 'copyright' エンティティを定義し、本文で '&copyright;' として参照しています。
21    $xmlContent = <<<XML
22<?xml version="1.0" encoding="UTF-8"?>
23<!DOCTYPE example [
24  <!ENTITY copyright "© 2023 MyCompany">
25]>
26<root>
27  <paragraph>This document contains an entity reference: &copyright;</paragraph>
28</root>
29XML;
30
31    // XML文字列をDOMDocumentにロードします。
32    if (!$dom->loadXML($xmlContent)) {
33        echo "エラー: XMLのロードに失敗しました。\n";
34        return;
35    }
36
37    // 3. ドキュメントツリーから DOMEntityReference ノードを探します。
38    // DOMEntityReferenceノードは、XMLのカスタムエンティティを参照する際に作成されます。
39    // XML_ENTITY_REF_NODE は、エンティティ参照ノードのタイプを示す定数です。
40    $entityReferenceNode = null;
41    foreach ($dom->getElementsByTagName('*') as $element) {
42        foreach ($element->childNodes as $childNode) {
43            if ($childNode->nodeType === XML_ENTITY_REF_NODE) {
44                $entityReferenceNode = $childNode;
45                break 2; // ノードが見つかったらループを抜けます。
46            }
47        }
48    }
49
50    // エンティティ参照ノードが見つかった場合のみ処理を実行します。
51    if ($entityReferenceNode instanceof DOMEntityReference) {
52        echo "DOMEntityReference ノードが見つかりました。ノード名: '{$entityReferenceNode->nodeName}'\n";
53
54        // 4. DOMEntityReference ノードの ownerDocument プロパティにアクセスします。
55        // ownerDocument は、そのノードが属する DOMDocument オブジェクトを返します。
56        // 戻り値は DOMDocument または null です。
57        $ownerDocument = $entityReferenceNode->ownerDocument;
58
59        if ($ownerDocument instanceof DOMDocument) {
60            echo "ownerDocument を取得しました。\n";
61
62            // 5. 取得した DOMDocument オブジェクトの saveHTML() メソッドを使ってHTML形式で出力します。
63            // saveHTML() は、ドキュメント全体をHTMLとして解釈し出力します。
64            // この際、エンティティ参照は展開された内容として表示されます。
65            echo "\n--- ownerDocument->saveHTML() の出力 ---\n";
66            echo $ownerDocument->saveHTML();
67            echo "----------------------------------------\n";
68        } else {
69            echo "エラー: ownerDocument は DOMDocument オブジェクトではありませんでした。\n";
70        }
71    } else {
72        echo "注意: ドキュメント内に DOMEntityReference ノードは見つかりませんでした。\n";
73        echo "この例では、XMLのカスタムDTDエンティティを使用してDOMEntityReference ノードを生成しています。\n";
74    }
75}
76
77// サンプル関数を実行します。
78demonstrateDomEntityReferenceOwnerDocument();

このサンプルコードは、PHPのDOM操作において、特定のノードがどのドキュメントに属しているかを確認する方法と、そのドキュメントの内容をHTML形式で出力する方法を示しています。まず、DOMDocumentオブジェクトを作成し、カスタムエンティティ参照を含むXMLコンテンツをロードします。このXMLでは&copyright;というエンティティ参照を定義しており、これが解析されるとDOMEntityReferenceという特殊なノードが生成されます。

次に、ロードされたドキュメントツリーの中からDOMEntityReferenceノードを探し出します。ノードが見つかったら、そのDOMEntityReferenceオブジェクトのownerDocumentプロパティにアクセスします。このownerDocumentプロパティは引数を取らず、そのノードが属しているDOMDocumentオブジェクト自体を返します。戻り値はDOMDocumentオブジェクトか、ノードがどのドキュメントにも属していない場合はnullです。

サンプルコードでは、取得したownerDocumentがDOMDocumentオブジェクトであることを確認した後、そのDOMDocumentオブジェクトのsaveHTML()メソッドを呼び出しています。saveHTML()メソッドは引数なしで、現在のDOMDocumentオブジェクトが表すドキュメント全体をHTML形式の文字列として返します。この際、XMLで定義されていた&copyright;のようなエンティティ参照は、定義された内容に展開されて出力されます。これにより、任意のDOMノードが属する元ドキュメントの全体像を、整形されたHTMLとして確認できることを示しています。

Copy
1<?php
2
3/**
4 * DOMEntityReference::ownerDocument プロパティのサンプルコード
5 *
6 * この関数は、DOMDocument オブジェクトを作成し、
7 * そのドキュメントに属する DOMEntityReference ノードを生成します。
8 * そして、DOMEntityReference ノードの ownerDocument プロパティが、
9 * そのノードを作成した元の DOMDocument オブジェクトを指していることを示します。
10 * ownerDocument プロパティは、すべての DOM ノードが持つ、
11 * そのノードが属する DOMDocument オブジェクトへの参照です。
12 */
13function demonstrateDomEntityReferenceOwnerDocument(): void
14{
15    // 1. 新しい DOMDocument オブジェクトを作成します。
16    // これは、これから作成する DOM ノードの「オーナー」となるドキュメントです。
17    $dom = new DOMDocument('1.0', 'UTF-8');
18
19    // 2. DOMDocument::createEntityReference() メソッドを使用して、
20    // DOMEntityReference ノードを作成します。
21    // ここでは、標準的な XML/HTML エンティティである 'amp' (アンパサンド) を例とします。
22    // このノードはまだドキュメントツリーに追加されていませんが、
23    // 生成時にオーナーとなる DOMDocument が割り当てられます。
24    $entityRef = $dom->createEntityReference('amp');
25
26    echo "--- DOMEntityReference::ownerDocument プロパティの確認 ---\n";
27    echo "作成された DOMEntityReference ノード名: " . $entityRef->nodeName . "\n";
28    echo "作成された DOMEntityReference ノードタイプ: " . $entityRef->nodeType . " (XML_ENTITY_REF_NODE)\n\n";
29
30    // 3. 作成した DOMEntityReference ノードの ownerDocument プロパティにアクセスします。
31    // このプロパティは、このノードが属している DOMDocument オブジェクトを返します。
32    $ownerDoc = $entityRef->ownerDocument;
33
34    // 4. 取得した ownerDocument が、ノードを生成した元の $dom オブジェクトと
35    // 同一のオブジェクトであるかを確認します。
36    // '===' (厳密な比較) を使用して、オブジェクトが同じインスタンスであるかをチェックします。
37    if ($ownerDoc === $dom) {
38        echo "✅ DOMEntityReference の ownerDocument は、ノードを生成した元の DOMDocument オブジェクトと同じです。\n";
39        echo "取得した ownerDocument オブジェクトのクラス: " . get_class($ownerDoc) . "\n";
40    } else {
41        echo "❌ DOMEntityReference の ownerDocument は、元の DOMDocument オブジェクトとは異なります。\n";
42        echo "取得した ownerDocument オブジェクトのクラス: " . (is_object($ownerDoc) ? get_class($ownerDoc) : 'null') . "\n";
43    }
44
45    // ノードがどのドキュメントに属しているかを示す基本的な概念を理解するのに役立ちます。
46}
47
48// 関数を実行してサンプルコードの動作を確認します。
49demonstrateDomEntityReferenceOwnerDocument();
50

PHPのDOMEntityReference::ownerDocumentプロパティは、XMLやHTMLドキュメントの構造を扱う際に、特定のノードがどのドキュメントに属しているかを示す重要な情報を提供します。このプロパティは引数を取らず、戻り値として、そのノードが所属するDOMDocumentオブジェクト、またはノードがまだどのドキュメントにも属していない場合はnullを返します。

提供されたサンプルコードでは、まず新しいDOMDocumentオブジェクトを作成し、これをこれから生成するDOMノードの「オーナー」となるドキュメントとします。次に、createEntityReferenceメソッドを使って'amp'という名前のDOMEntityReferenceノードを生成します。このノードはまだドキュメントツリーには追加されていませんが、生成時にすでにオーナーであるDOMDocumentが割り当てられています。

コードの核心は、このDOMEntityReferenceノードのownerDocumentプロパティにアクセスし、その戻り値が、ノードを生成した元のDOMDocumentオブジェクトと厳密に同一のインスタンスであるかを確認する点です。実行結果は「✅ DOMEntityReference の ownerDocument は、ノードを生成した元の DOMDocument オブジェクトと同じです。」と表示され、ownerDocumentプロパティが正しくノードの所属ドキュメントを指し示していることを証明しています。これにより、各DOMノードがどのドキュメントに紐づいているかという、DOMの基本的な概念を理解することができます。このプロパティは、DOMツリー内でノードがその親ドキュメントとどのように関連付けられているかを追跡するために役立ちます。