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

Copy
1<?php
2
3/**
4 * DOMCdataSectionのownerDocumentプロパティとDOMDocumentのsaveHTMLメソッドの使用例を示します。
5 * システムエンジニアを目指す初心者向けに、CDATAセクションを含むHTMLを生成し、
6 * その所有者ドキュメントを取得してHTML全体を文字列として保存する方法を解説します。
7 */
8function demonstrateCdataOwnerDocument(): void
9{
10    // 1. 新しいDOMDocumentオブジェクトを作成します。
11    // '1.0' はXMLのバージョン、'UTF-8' はエンコーディングを指定します。
12    $dom = new DOMDocument('1.0', 'UTF-8');
13    // 生成されるHTMLのフォーマットを整えるため、formatOutputプロパティをtrueに設定します。
14    $dom->formatOutput = true;
15
16    // 2. HTMLのルート要素を作成し、ドキュメントに追加します。
17    $htmlElement = $dom->createElement('html');
18    $dom->appendChild($htmlElement);
19
20    // 3. body要素を作成し、HTML要素の子として追加します。
21    $bodyElement = $dom->createElement('body');
22    $htmlElement->appendChild($bodyElement);
23
24    // 4. DOMCdataSectionオブジェクトを作成します。
25    // CDATAセクションは、HTMLとして解釈されたくないテキスト（例: HTMLタグや特殊文字）を
26    // そのままデータとして保持するために使用されます。
27    $cdataSection = $dom->createCDATASection('このテキストは <p>HTMLタグ</p> を含みますが、エスケープされずにそのまま表示されます。');
28
29    // 5. p要素を作成し、その中にCDATAセクションを追加します。
30    $pElement = $dom->createElement('p');
31    $pElement->appendChild($cdataSection);
32    $bodyElement->appendChild($pElement);
33
34    // 6. 作成したCDATAセクション（$cdataSection）のownerDocumentプロパティを使って、
35    // それがどのDOMDocumentオブジェクトに所属しているかを取得します。
36    // ownerDocumentプロパティは、DOMDocumentオブジェクトまたはnullを返します。
37    $ownerDoc = $cdataSection->ownerDocument;
38
39    // 7. ownerDocumentが正しく取得できたか確認します。
40    if ($ownerDoc instanceof DOMDocument) {
41        echo "CDATAセクションの所有者ドキュメントが正常に取得できました。\n\n";
42
43        // 8. 取得したDOMDocumentオブジェクト全体をHTML文字列として保存（出力）します。
44        // saveHTML() メソッドは、ドキュメント全体または特定のノードのHTML表現を返します。
45        echo "生成されたHTML:\n";
46        echo $ownerDoc->saveHTML();
47    } else {
48        echo "エラー: CDATAセクションの所有者ドキュメントが取得できませんでした。\n";
49    }
50}
51
52// 上記の関数を実行し、デモンストレーションを開始します。
53demonstrateCdataOwnerDocument();

このサンプルコードは、PHPのDOM拡張機能を使用し、CDATAセクションを含むHTMLドキュメントを作成および操作する方法を示しています。まず、新しいDOMDocumentオブジェクトを作成し、HTMLのルート構造とボディ要素を追加します。次に、createCDATASectionメソッドを使ってDOMCdataSectionオブジェクトを作成します。CDATAセクションは、HTMLとして解釈されたくないテキスト、例えばHTMLタグそのものや特殊文字などを、エスケープせずにそのままデータとしてドキュメント内に保持するために利用されます。

作成されたDOMCdataSectionオブジェクトのownerDocumentプロパティは、そのCDATAセクションがどのDOMDocumentオブジェクトに所属しているかを取得するために使われます。このプロパティは引数を取らず、所属するDOMDocumentオブジェクト、または所属ドキュメントがない場合はnullを戻り値として返します。これにより、特定のノードがどのドキュメントツリーに属しているかを容易に特定できます。

ownerDocumentプロパティで取得したDOMDocumentオブジェクトに対しては、saveHTML()メソッドを呼び出すことで、ドキュメント全体をHTML形式の文字列として取得し、出力することができます。このメソッドも引数なしで呼び出すことができ、完成したHTML文字列を戻り値として返します。サンプルコードを実行することで、CDATAセクションが正しく埋め込まれたHTMLドキュメントが生成され、その所有者ドキュメントから完全なHTML文字列として出力されるプロセスを体験できます。これは、DOM操作の基礎と、特殊なコンテンツの取り扱いを理解する上で非常に役立つでしょう。

Copy
1<?php
2
3/**
4 * Demonstrates how to use the ownerDocument property of a DOMCdataSection.
5 *
6 * This function creates a DOMDocument, adds a CDATA section to it,
7 * then retrieves that CDATA section and accesses its ownerDocument property
8 * to show which document it belongs to.
9 */
10function demonstrateCdataOwnerDocument(): void
11{
12    // 1. 新しいDOMDocumentを作成します。
13    //    XMLバージョン1.0、エンコーディングUTF-8を指定します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    // 出力時にXMLを整形するためのオプション
16    $dom->formatOutput = true;
17
18    // 2. ルート要素 'root' を作成し、ドキュメントに追加します。
19    $root = $dom->createElement('root');
20    $dom->appendChild($root);
21
22    // 3. 要素 'data' を作成し、ルート要素に追加します。
23    $dataElement = $dom->createElement('data');
24    $root->appendChild($dataElement);
25
26    // 4. CDATAセクションを作成します。
27    //    CDATAセクションは、XMLパーサによって解析されないテキストを保持するために使用されます。
28    //    HTMLタグや特殊文字（&など）をそのまま含めることができます。
29    $cdataSection = $dom->createCDATASection(
30        'この部分はCDATAセクションです。XMLとして解析されません。' . "\n" .
31        '例: <tag> & "quoted" characters.'
32    );
33
34    // 5. 作成したCDATAセクションを 'data' 要素に追加します。
35    $dataElement->appendChild($cdataSection);
36
37    echo "--- 作成されたXMLドキュメント --- \n";
38    echo $dom->saveXML() . "\n\n";
39
40    echo "--- CDATAセクションのownerDocumentプロパティへのアクセス --- \n";
41
42    // 6. ドキュメントツリーからCDATAセクションノードを取得します。
43    //    この例では、`$cdataSection`変数を直接使用していますが、
44    //    既存のXMLを読み込んだ場合はDOMトラバーサルでノードを見つける必要があります。
45    $retrievedCdata = null;
46    foreach ($dataElement->childNodes as $node) {
47        if ($node instanceof DOMCdataSection) {
48            $retrievedCdata = $node;
49            break;
50        }
51    }
52
53    if ($retrievedCdata) {
54        // 7. CDATAセクションのownerDocumentプロパティにアクセスします。
55        //    このプロパティは、このノードが属しているDOMDocumentオブジェクトを返します。
56        //    ノードがまだドキュメントツリーに属していない場合はnullを返しますが、
57        //    ここでは既にDOMに属しているのでDOMDocumentオブジェクトが返されます。
58        $ownerDocument = $retrievedCdata->ownerDocument;
59
60        echo "取得したCDATAセクションのテキスト内容: \n";
61        echo "  " . str_replace("\n", "\n  ", $retrievedCdata->nodeValue) . "\n";
62
63        // 8. ownerDocumentが期待通りDOMDocumentインスタンスであるか確認します。
64        if ($ownerDocument instanceof DOMDocument) {
65            echo "ownerDocumentはDOMDocumentのインスタンスです。クラス: " . get_class($ownerDocument) . "\n";
66
67            // 9. 取得したownerDocumentが、元々作成した$domオブジェクトと同一であるか確認します。
68            if ($ownerDocument === $dom) {
69                echo "成功: ownerDocumentは、元々作成したDOMDocumentオブジェクトと同一です。\n";
70            } else {
71                echo "エラー: ownerDocumentが元のDOMDocumentと一致しません。\n";
72            }
73
74            // ownerDocumentからドキュメントのプロパティにアクセスできることを示します。
75            echo "ownerDocumentから取得したXMLバージョン: " . $ownerDocument->xmlVersion . "\n";
76            echo "ownerDocumentから取得したXMLエンコーディング: " . $ownerDocument->xmlEncoding . "\n";
77        } else {
78            echo "エラー: ownerDocumentはDOMDocumentインスタンスではありません。返り値: " . var_export($ownerDocument, true) . "\n";
79        }
80    } else {
81        echo "エラー: ドキュメント内にCDATAセクションが見つかりませんでした。\n";
82    }
83}
84
85// 関数を実行してデモンストレーションを開始します。
86demonstrateCdataOwnerDocument();
87

PHPのDOMCdataSectionクラスに用意されているownerDocumentプロパティは、特定のCDATAセクションがどのXMLドキュメント（DOMDocumentオブジェクト）に属しているのかを示すために使用されます。このプロパティは引数を必要とせず、そのCDATAセクションが組み込まれているDOMDocumentオブジェクトを返します。もしCDATAセクションがまだどのドキュメントにも追加されていない場合は、nullを返します。

サンプルコードでは、まず新しいDOMDocumentオブジェクトを作成し、その中にルート要素と、XMLとして解析されたくない文字列を含むCDATAセクションを追加しています。その後、作成したCDATAセクションからownerDocumentプロパティにアクセスし、どのDOMDocumentに属しているかを取得しています。実行結果として、このプロパティが、元のDOMDocumentオブジェクトと完全に同一のインスタンスを返すことが確認できます。これにより、XMLドキュメント内の特定のノードが、どの親ドキュメントに属しているかを簡単に特定でき、複雑なXML構造をプログラムで操作する際の基盤となります。