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

Copy
1<?php
2
3/**
4 * DOMNotation の ownerDocument プロパティと DOMDocument の saveHTML メソッドの使用例を示します。
5 *
6 * ownerDocument プロパティは、ある DOMNode (DOMNotation も含む) が属する
7 * DOMDocument オブジェクトを返します。
8 * saveHTML メソッドは、DOMDocument の内容を HTML 文字列として出力します。
9 * XML ドキュメントの場合でも、多くの場合 saveHTML は saveXML と同様の結果を返します。
10 */
11function demonstrateDomNotationOwnerDocumentAndSaveHtml(): void
12{
13    // DTD (Document Type Definition) を含むXML文字列を作成し、
14    // NOTATION 宣言を含めます。DOMNotation は DTD の一部です。
15    $xmlString = <<<XML
16<?xml version="1.0"?>
17<!DOCTYPE root [
18    <!NOTATION gif SYSTEM "image/gif">
19    <!NOTATION jpeg SYSTEM "image/jpeg">
20    <!ELEMENT root EMPTY>
21    <!ATTLIST root
22        imageType NOTATION (gif | jpeg) #REQUIRED
23    >
24]>
25<root imageType="gif"/>
26XML;
27
28    // 新しい DOMDocument オブジェクトを作成し、XMLをロードします。
29    $dom = new DOMDocument();
30    $dom->loadXML($xmlString);
31
32    $notation = null;
33    // ドキュメントの DTD から、'gif' という名前の DOMNotation を取得します。
34    // DOMNotation は通常、XMLのDTD内で定義されます。
35    if ($dom->doctype && $dom->doctype->notations) {
36        $notation = $dom->doctype->notations->getNamedItem('gif');
37    }
38
39    // DOMNotation オブジェクトが正しく取得できたか確認します。
40    if ($notation instanceof DOMNotation) {
41        echo "--- DOMNotation '{$notation->nodeName}' が見つかりました ---\n";
42
43        // DOMNotation の ownerDocument プロパティを使用して、
44        // この表記が属する DOMDocument オブジェクトを取得します。
45        // このプロパティは DOMNotation を含むすべての DOMNode で利用可能です。
46        $ownerDoc = $notation->ownerDocument;
47
48        if ($ownerDoc instanceof DOMDocument) {
49            echo "DOMNotation の ownerDocument を取得しました。これは元の DOMDocument です。\n\n";
50
51            // 取得した DOMDocument の内容を HTML (または XML) 文字列として出力します。
52            echo "--- ownerDocument->saveHTML() の出力 ---\n";
53            echo $ownerDoc->saveHTML();
54            echo "--------------------------------------\n";
55        } else {
56            echo "エラー: ownerDocument が null です。\n";
57        }
58    } else {
59        echo "エラー: DOMNotation 'gif' を見つけることができませんでした。";
60        echo "XML文字列またはDTDの定義を確認してください。\n";
61    }
62}
63
64// 関数を実行します。
65demonstrateDomNotationOwnerDocumentAndSaveHtml();

このサンプルコードは、PHPのDOM拡張機能におけるDOMNotationクラスのownerDocumentプロパティと、DOMDocumentクラスのsaveHTMLメソッドの利用方法を示しています。

DOMNotationはXMLのDTD（Document Type Definition）で定義される、データ形式などを識別するための表記情報を表すクラスです。ownerDocumentプロパティは、このDOMNotationインスタンスがどのDOMDocumentオブジェクトに属しているかを返します。引数はなく、戻り値は所属するDOMDocumentオブジェクトか、存在しない場合はnullとなります。これにより、あるDOMノードがどのドキュメントの一部であるかを簡単に判別できます。

一方、DOMDocument::saveHTML()メソッドは、現在ロードされているDOMDocumentオブジェクト全体のHTML表現を文字列として取得します。このメソッドはXMLドキュメントに対しても機能し、多くの場合saveXML()と同様の結果を返します。

サンプルコードでは、まずDTDにNOTATION宣言を含むXMLを作成し、それをDOMDocumentにロードします。次に、DTDから特定のDOMNotationオブジェクトを取得し、そのownerDocumentプロパティを通じて元のDOMDocumentインスタンスを取得します。最後に、取得したDOMDocumentに対してsaveHTML()メソッドを呼び出し、ドキュメント全体の構造をHTML文字列として出力しています。

Copy
1<?php
2
3/**
4 * DOMNotation の ownerDocument プロパティの使用例を示します。
5 *
6 * この関数は、XML ドキュメントを作成し、その中に定義された NOTATION ノードから
7 * ownerDocument プロパティを取得し、それが元のドキュメントと一致することを確認します。
8 * ownerDocument プロパティは、そのノードが属する DOMDocument オブジェクトを返します。
9 */
10function demonstrateDomNotationOwnerDocument(): void
11{
12    // 1. 新しい DOMDocument オブジェクトを作成します。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    $dom->formatOutput = true; // 出力を整形するために設定
15
16    // 2. DOMNotation を含む XML 文字列を定義します。
17    //    DOMNotation は DOCTYPE 宣言の一部として定義されます。
18    //    ここでは 'image-viewer' という名前の NOTATION を定義しています。
19    $xmlString = <<<XML
20<?xml version="1.0" encoding="UTF-8"?>
21<!DOCTYPE root [
22  <!NOTATION image-viewer SYSTEM "image-viewer.exe">
23  <!ELEMENT root EMPTY>
24]>
25<root/>
26XML;
27
28    // XML 文字列を DOMDocument にロードします。
29    $dom->loadXML($xmlString);
30
31    echo "--- 元の DOMDocument の情報 ---" . PHP_EOL;
32    echo "元の DOMDocument のクラス名: " . get_class($dom) . PHP_EOL;
33    echo "元の DOMDocument のノード名: " . $dom->nodeName . PHP_EOL;
34    echo PHP_EOL;
35
36    // 3. ドキュメントから DOCTYPE ノード (DOMDocumentType) を取得します。
37    //    DOMNotation は DOMDocumentType の子ノードとして扱われます。
38    $doctype = $dom->doctype;
39
40    if ($doctype instanceof DOMDocumentType) {
41        echo "--- DOCTYPE ノードの情報 ---" . PHP_EOL;
42        echo "DOCTYPE ノードのノード名: " . $doctype->nodeName . PHP_EOL; // 例: doctype
43        echo "DOCTYPE のシステムID: " . $doctype->systemId . PHP_EOL;
44        echo PHP_EOL;
45
46        // 4. DOCTYPE ノードの notations プロパティから DOMNotation オブジェクトを取得します。
47        //    notations プロパティは DOMNamedNodeMap を返します。
48        $notations = $doctype->notations;
49
50        if ($notations->length > 0) {
51            // 定義した 'image-viewer' という名前の DOMNotation を取得します。
52            /** @var DOMNotation|null $notation */
53            $notation = $notations->getNamedItem('image-viewer');
54
55            if ($notation instanceof DOMNotation) {
56                echo "--- 取得した DOMNotation ノードの情報 ---" . PHP_EOL;
57                echo "DOMNotation ノード名: " . $notation->nodeName . PHP_EOL; // 例: image-viewer
58                echo "DOMNotation システムID: " . $notation->systemId . PHP_EOL;
59                echo PHP_EOL;
60
61                // 5. DOMNotation オブジェクトの ownerDocument プロパティにアクセスします。
62                //    このプロパティは、このノードが属する DOMDocument オブジェクトを返します。
63                $ownerDoc = $notation->ownerDocument;
64
65                echo "--- DOMNotation の ownerDocument プロパティ ---" . PHP_EOL;
66                if ($ownerDoc instanceof DOMDocument) {
67                    echo "ownerDocument のクラス名: " . get_class($ownerDoc) . PHP_EOL;
68                    echo "ownerDocument のノード名: " . $ownerDoc->nodeName . PHP_EOL;
69
70                    // 6. 返された ownerDocument が元の DOMDocument と同じオブジェクトであることを確認します。
71                    if ($ownerDoc === $dom) {
72                        echo "結果: ownerDocument は元の DOMDocument と同じオブジェクトです。" . PHP_EOL;
73                    } else {
74                        echo "結果: ownerDocument は元の DOMDocument と異なるオブジェクトです。" . PHP_EOL;
75                    }
76                } else {
77                    echo "結果: ownerDocument は null です (取得できませんでした)。" . PHP_EOL;
78                }
79            } else {
80                echo "エラー: 'image-viewer' という名前の DOMNotation が見つかりませんでした。" . PHP_EOL;
81            }
82        } else {
83            echo "情報: DOCTYPE に NOTATION が定義されていません。" . PHP_EOL;
84        }
85    } else {
86        echo "情報: ドキュメントに DOCTYPE ノードが見つかりませんでした。" . PHP_EOL;
87    }
88}
89
90// 関数を実行して、DOMNotation の ownerDocument プロパティの動作を確認します。
91demonstrateDomNotationOwnerDocument();

DOMNotation::ownerDocumentプロパティは、XMLドキュメント内のNOTATIONノードが、どのDOMDocumentオブジェクトに属しているかを取得するためのプロパティです。このプロパティは引数を取らず、戻り値としてそのノードが所属するDOMDocumentオブジェクトを返します。もしノードがまだドキュメントツリーに追加されていないなどの場合はnullを返すこともあります。

このプロパティは、XML構造を扱う際に、特定のノードがどの親ドキュメントに紐づいているかを確認するために利用されます。提供されたサンプルコードでは、まず新しいDOMDocumentオブジェクトを作成し、その中にNOTATION定義を含むXMLを読み込んでいます。次に、読み込まれたXMLから特定のNOTATIONノード（例では'image-viewer'）を取得し、そのownerDocumentプロパティにアクセスします。そして、取得したownerDocumentが、最初に作成したDOMDocumentオブジェクトと完全に同じものであることを確認しています。これにより、ownerDocumentプロパティが、ノードの「持ち主」であるドキュメントを正しく返している様子が具体的に示されており、ノードとドキュメント間の関連性を明確に把握することができます。