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

Copy
1<?php
2
3/**
4 * Dom\Notation の ownerDocument プロパティと Dom\Document::saveHTML() の使用例を示します。
5 *
6 * この関数は、DTD (Document Type Definition) 内で定義された Dom\Notation オブジェクトを検索し、
7 * その ownerDocument プロパティを通じて元の Dom\Document オブジェクトを取得します。
8 * 最後に、取得した Dom\Document オブジェクトを saveHTML() メソッドで文字列として出力します。
9 *
10 * システムエンジニアを目指す初心者向けに、各ステップをコメントで詳しく解説します。
11 */
12function demonstrateNotationOwnerDocument(): void
13{
14    // 1. XML ドキュメントを定義します。
15    // ここでは、DTD (Document Type Definition) で2つの NOTATION (表記法) を定義しています。
16    // NOTATIONはXMLドキュメント内で、外部の非XMLデータ形式（例：画像フォーマット）を宣言し、
17    // それらを参照するために使用されます。HTMLではあまり一般的ではありません。
18    $xmlString = <<<XML
19<?xml version="1.0"?>
20<!DOCTYPE example [
21  <!NOTATION gif SYSTEM "image/gif">
22  <!NOTATION jpeg SYSTEM "image/jpeg">
23]>
24<example>
25  <image source="foo.gif" type="gif"/>
26</example>
27XML;
28
29    echo "--- XML ドキュメントの読み込み ---" . PHP_EOL;
30
31    // 2. Dom\Document オブジェクトを新規作成します。
32    // このオブジェクトがDOMツリー全体のルートになります。
33    $dom = new Dom\Document();
34
35    // 3. XML 文字列を Dom\Document にロードします。
36    // ロードに失敗した場合（不正なXMLなど）はfalseを返すため、エラー処理を行います。
37    if (!$dom->loadXML($xmlString)) {
38        echo "エラー: XMLのロードに失敗しました。" . PHP_EOL;
39        return;
40    }
41    echo "XMLが正常にロードされました。" . PHP_EOL;
42
43    // 4. ドキュメントの DOCTYPE (文書型定義) を取得します。
44    // DTDに定義された NOTATION は、この Dom\DocumentType オブジェクトを介してアクセスできます。
45    $doctype = $dom->doctype;
46
47    // 5. DOCTYPE が存在しない場合は処理を終了します。
48    // NOTATIONはDTDの一部として定義されるため、DOCTYPEが必要です。
49    if (!$doctype) {
50        echo "エラー: ドキュメントに DOCTYPE が見つかりませんでした。" . PHP_EOL;
51        return;
52    }
53    echo "DOCTYPE が見つかりました: " . $doctype->name . PHP_EOL;
54
55    // 6. DOCTYPE に定義された NOTATION のコレクション (NamedNodeMap) を取得します。
56    $notations = $doctype->notations;
57
58    // 7. コレクションが空でないか確認します。
59    // NOTATIONが定義されていない場合は処理を終了します。
60    if ($notations->count() === 0) {
61        echo "エラー: ドキュメントに NOTATION が見つかりませんでした。" . PHP_EOL;
62        return;
63    }
64    echo "NOTATION の数: " . $notations->count() . PHP_EOL;
65
66    // 8. コレクションから特定の NOTATION ('gif') を名前で取得します。
67    // getNamedItem() は指定された名前のノードを返します。
68    $gifNotation = $notations->getNamedItem('gif');
69
70    // 9. 取得したノードが期待通り Dom\Notation のインスタンスであるか確認します。
71    if (!$gifNotation instanceof Dom\Notation) {
72        echo "エラー: 指定された NOTATION 'gif' が見つからないか、Dom\\Notation ではありませんでした。" . PHP_EOL;
73        return;
74    }
75    echo "取得した NOTATION の名前: " . $gifNotation->nodeName . PHP_EOL;
76    echo "取得した NOTATION のシステムID: " . $gifNotation->systemId . PHP_EOL;
77
78    echo PHP_EOL . "--- ownerDocument プロパティの確認 ---" . PHP_EOL;
79
80    // 10. Dom\Notation オブジェクトの ownerDocument プロパティにアクセスします。
81    // このプロパティは、このノード（$gifNotation）が属する Dom\Document オブジェクトを返します。
82    // すべてのDomノードは、どのDom\Documentに属しているかを知ることができます。
83    $ownerDocument = $gifNotation->ownerDocument;
84
85    // 11. ownerDocument が期待通り Dom\Document のインスタンスであることを確認します。
86    if ($ownerDocument instanceof Dom\Document) {
87        echo "ownerDocument は Dom\Document のインスタンスです。" . PHP_EOL;
88        // 取得した ownerDocument は、元の $dom オブジェクトと同じインスタンスであるはずです。
89        echo "ownerDocument と元の Dom\Document は同じオブジェクトですか？ " .
90             ($ownerDocument === $dom ? "はい" : "いいえ") . PHP_EOL;
91
92        echo PHP_EOL . "--- saveHTML() を使用した出力 ---" . PHP_EOL;
93
94        // 12. キーワード 'savehtml' に従って、取得した Dom\Document を HTML 文字列として保存します。
95        // Dom\Document::saveHTML() は、XMLドキュメントであってもHTMLとして出力しようとします。
96        // このため、XMLのDTD情報（NOTATIONの定義を含む）は通常出力されません。
97        // XMLの厳密な出力には Dom\Document::saveXML() を使用するのが一般的です。
98        $htmlOutput = $ownerDocument->saveHTML();
99        echo "取得した Dom\Document を saveHTML() で出力した結果:" . PHP_EOL;
100        echo "----------------------------------------------------" . PHP_EOL;
101        // HTML特殊文字をエスケープして、コンソールで正しく表示されるようにします。
102        // 例えば、'<' や '>' は '&lt;' や '&gt;' に変換されます。
103        echo htmlspecialchars($htmlOutput);
104        echo PHP_EOL . "----------------------------------------------------" . PHP_EOL;
105    } else {
106        echo "エラー: ownerDocument は Dom\Document のインスタンスではありませんでした。" . PHP_EOL;
107    }
108}
109
110// 関数を実行して、サンプルコードの動作を確認します。
111demonstrateNotationOwnerDocument();

このサンプルコードは、PHPのDOM拡張機能におけるDom\NotationクラスのownerDocumentプロパティと、Dom\DocumentクラスのsaveHTML()メソッドの具体的な使用方法を、システムエンジニアを目指す初心者向けに示しています。

まず、XMLドキュメントをロードし、その中で定義されているDTD（Document Type Definition）から、gifという名前のDom\Notationオブジェクトを取得します。Dom\Notationは、XMLドキュメント内で外部の非XMLデータ形式を宣言する際に使われるノードの一種です。

次に、このDom\NotationオブジェクトからownerDocumentプロパティにアクセスします。このプロパティは、該当するノードがどのDom\Documentオブジェクトに属しているかを示すもので、通常はノードが作成された元のDom\Documentオブジェクトが返されます。戻り値はDom\Documentオブジェクト、またはノードがまだドキュメントに属していない場合はnullとなります。このプロパティを利用することで、ツリー内の任意のノードから、そのノードの親ドキュメント全体へ簡単にアクセスでき、ドキュメント全体の操作に役立ちます。

最後に、取得したDom\Documentオブジェクトに対してsaveHTML()メソッドを呼び出します。このメソッドは引数を取らず、現在のドキュメント全体をHTML形式の文字列として返します。元がXMLドキュメントであっても、saveHTML()はHTMLとして解釈可能な部分を文字列化しようとします。これにより、DOMツリー構造を最終的な出力形式で確認することが可能となります。

Copy
1<?php
2
3/**
4 * Dom\Notation クラスの ownerDocument プロパティの使用例を示します。
5 * ownerDocument プロパティは、ノードが属する Dom\Document オブジェクトを返します。
6 *
7 * システムエンジニアを目指す初心者向けに、XML文書とDTD（Document Type Definition）から
8 * Dom\Notation を取得し、その ownerDocument が元のドキュメントを指していることを確認します。
9 */
10function demonstrateDomNotationOwnerDocument(): void
11{
12    // DTD で NOTATION（表記法）が定義された XML 文字列を作成します。
13    // NOTATION は、XML文書外のリソースの形式を宣言するために使用されます。
14    $xmlString = <<<XML
15<!DOCTYPE root [
16  <!NOTATION gif SYSTEM "image/gif">
17  <!ELEMENT root EMPTY>
18]>
19<root/>
20XML;
21
22    echo "--- Dom\\Notation::ownerDocument のデモンストレーション ---\n\n";
23
24    // 1. Dom\Document オブジェクトを作成し、XML 文字列をロードします。
25    //    この処理により、XML がパースされ、DTD も解析されます。
26    $dom = new Dom\Document();
27    $dom->loadXML($xmlString);
28
29    echo "元の Dom\\Document オブジェクトのハッシュ値: " . spl_object_hash($dom) . "\n\n";
30
31    // 2. ドキュメントタイプ定義 (DTD) を取得します。
32    //    Dom\Notation は DTD 内で定義されます。
33    $docType = $dom->doctype;
34
35    // DTD が存在し、かつ表記法（NOTATION）が定義されているかを確認します。
36    if ($docType && $docType->notations->length > 0) {
37        // 3. DTD から最初の Dom\Notation ノードを取得します。
38        //    notations プロパティは Dom\NamedNodeMap であり、item() メソッドで個々のノードを取得します。
39        $notation = $docType->notations->item(0);
40
41        // 取得したノードが Dom\Notation のインスタンスであることを確認します。
42        if ($notation instanceof Dom\Notation) {
43            echo "取得した Dom\\Notation ノードの名前: " . $notation->nodeName . " (SYSTEM ID: " . $notation->systemId . ")\n";
44
45            // 4. Dom\Notation オブジェクトの ownerDocument プロパティにアクセスします。
46            //    このプロパティは、このノードが「誰に属しているか（どのドキュメントに属しているか）」を示します。
47            $ownerDocument = $notation->ownerDocument;
48
49            if ($ownerDocument) {
50                echo "Dom\\Notation の ownerDocument プロパティが返す Dom\\Document オブジェクトのハッシュ値: " . spl_object_hash($ownerDocument) . "\n";
51
52                // 5. ownerDocument が元の $dom オブジェクトと同じかどうかをチェックします。
53                //    これは、ノードが正しくドキュメントに属していることを示します。
54                if ($ownerDocument === $dom) {
55                    echo "-> ownerDocument は元の Dom\\Document オブジェクトと一致します。\n";
56                    echo "   これは、'gif' 表記法ノードが正しくこの XML ドキュメントに属していることを意味します。\n";
57                } else {
58                    echo "-> ownerDocument は元の Dom\\Document オブジェクトと一致しません。(これは予期しない状況です)\n";
59                }
60            } else {
61                echo "Dom\\Notation の ownerDocument プロパティは null を返しました。\n";
62                echo "これは通常、ノードがまだどのドキュメントにも追加されていない場合に発生します。\n";
63            }
64        } else {
65            echo "エラー: 期待される Dom\\Notation のインスタンスが見つかりませんでした。\n";
66        }
67    } else {
68        echo "ドキュメントタイプ定義 (DTD) または表記法 (NOTATION) が見つかりませんでした。\n";
69    }
70
71    echo "\n--- デモンストレーション終了 ---\n";
72}
73
74// 関数を実行して、Dom\Notation::ownerDocument の動作を確認します。
75demonstrateDomNotationOwnerDocument();

PHP 8のDom\NotationクラスにあるownerDocumentプロパティは、XML文書内で定義された表記法（NOTATION）ノードが、どのDom\Documentオブジェクトに属しているかを特定するために使用されます。このプロパティは引数を取らず、戻り値としてそのノードが属するDom\Documentオブジェクトを返します。もしノードがまだどのドキュメントにも追加されていない場合はnullを返します。

サンプルコードでは、まずDTD（Document Type Definition）内で「gif」という名前のNOTATIONが定義されたXML文字列を作成し、それをDom\Documentオブジェクトにロードしています。次に、ロードされたドキュメントからDTD情報を取得し、その中からDom\Notationオブジェクト「gif」を取り出します。取得したDom\NotationオブジェクトのownerDocumentプロパティにアクセスすると、XMLをロードした元のDom\Documentオブジェクトが返されることを確認できます。これにより、「gif」というNOTATIONノードが正しく元のドキュメントに属していることが示されます。ownerDocumentは、XMLツリー内の任意のノードがどの最上位ドキュメントに属するかを効率的に把握するために役立つプロパティです。