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

ownerDocumentプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年11月13日

基本的な使い方

ownerDocumentプロパティは、DOM (Document Object Model) ツリー内の文字データを持つノード（例えばテキストやコメントなど）が、どのドキュメントに属しているかを識別するための情報を保持するプロパティです。PHPのDOM拡張機能におけるDom\CharacterDataクラスは、こうした文字情報を持つノードを表しており、このプロパティはそのノードを「所有」しているDom\Documentオブジェクトへの参照を保持します。

すべてのDOMノードは、必ず何らかのドキュメントの一部として存在します。このownerDocumentプロパティを利用することで、現在操作しているノードがどのドキュメントによって生成され、管理されているかを確認できます。これは、たとえば既存のドキュメントに新しい要素やテキストを追加する際に、そのノードを作成するための適切なドキュメントオブジェクトを取得する場合や、ノードが属するドキュメント全体に対して特定の操作を行いたい場合などに非常に役立ちます。ノードの親要素とは異なり、このプロパティは常にそのノードが最終的に属する最上位のドキュメントオブジェクトを指し示します。DOM構造を理解し、ウェブページやXMLデータといった構造化されたドキュメントをPHPで適切に操作するために、このプロパティは基本的な情報源として機能します。

構文(syntax)


1<?php
2
3$document = new Dom\Document();
4$characterDataNode = $document->createTextNode("Example text data.");
5
6$ownerDoc = $characterDataNode->ownerDocument;

引数(parameters)

引数なし

引数はありません

戻り値(return)

Dom\Document|null

このプロパティは、このDom\CharacterDataノードが属するDom\Documentオブジェクトを返します。もしノードがドキュメントに属していない場合はnullを返します。

サンプルコード

テキストノードからドキュメントを操作しHTMLを保存する


1<?php
2
3/**
4 * Dom\CharacterData::ownerDocument プロパティと DOMDocument::saveHTML() メソッドの使用例を示します。
5 *
6 * この関数は、新しい DOMDocument を作成し、テキストノードを含む簡単なHTML構造を構築します。
7 * その後、テキストノード（Dom\CharacterData を継承）の ownerDocument プロパティにアクセスし、
8 * そのノードが属するドキュメントを確認します。
9 * 最後に、saveHTML() を使用して、生成されたHTMLコンテンツ全体を出力します。
10 */
11function demonstrateDomOwnerDocumentAndSaveHtml(): void
12{
13    // 1. 新しい DOMDocument を作成します。
14    // '1.0' はXMLバージョン、'UTF-8' はエンコーディングを指定します。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    // 出力時にHTMLを整形して読みやすくします。
17    $dom->formatOutput = true;
18
19    // 2. HTML要素を作成します。
20    $htmlElement = $dom->createElement('html');
21    $bodyElement = $dom->createElement('body');
22    $paragraphElement = $dom->createElement('p');
23
24    // 3. テキストノードを作成します。
25    // DOMText は Dom\CharacterData を継承するクラスです。
26    $textNode = $dom->createTextNode('これはDOMドキュメント内のサンプルテキストです。');
27
28    // 4. 要素とノードを階層的に構築します。
29    $paragraphElement->appendChild($textNode);    // テキストノードを<p>要素に追加
30    $bodyElement->appendChild($paragraphElement); // <p>要素を<body>要素に追加
31    $htmlElement->appendChild($bodyElement);     // <body>要素を<html>要素に追加
32    $dom->appendChild($htmlElement);             // <html>要素をドキュメントのルートに追加
33
34    echo "--- Dom\\CharacterData::ownerDocument の確認 ---\n";
35
36    // 5. テキストノードの ownerDocument プロパティにアクセスします。
37    // このプロパティは、このノードが属する Dom\Document オブジェクトを返します。
38    $ownerDocument = $textNode->ownerDocument;
39
40    if ($ownerDocument instanceof DOMDocument) {
41        echo "テキストノードの ownerDocument は DOMDocument オブジェクトです。\n";
42        // 作成したDOMDocumentオブジェクトと、ノードのownerDocumentが同一であるか確認します。
43        if ($dom === $ownerDocument) {
44            echo "元の DOMDocument オブジェクトと同じであることが確認されました。\n";
45        } else {
46            echo "エラー: ownerDocument が元の DOMDocument と異なります。\n";
47        }
48    } else {
49        echo "エラー: ownerDocument が DOMDocument オブジェクトではないか、null です。\n";
50    }
51    echo "\n";
52
53    echo "--- DOMDocument::saveHTML() による出力 ---\n";
54
55    // 6. ドキュメント全体のHTML表現を取得し、出力します。
56    // saveHTML() は、現在のDOMツリー全体のHTML文字列を返します。
57    echo $dom->saveHTML();
58}
59
60// 関数を実行して、DOM操作と出力のデモンストレーションを行います。
61demonstrateDomOwnerDocumentAndSaveHtml();

PHPのDOM拡張機能は、HTMLやXML文書をプログラムで操作するための機能を提供します。このサンプルコードでは、文書内のテキストデータに焦点を当てたDom\CharacterData::ownerDocumentプロパティと、文書全体のHTMLを出力するDOMDocument::saveHTML()メソッドの使用例を示しています。

Dom\CharacterData::ownerDocumentプロパティは、テキストノードのような文字データが「どのドキュメントに属しているか」を示すためのものです。このプロパティに引数はなく、該当するノードが属するDom\Documentオブジェクトを返します。もしノードがまだどのドキュメントにも追加されていない場合はnullが返されます。これにより、特定のノードがどのDOMツリーの一部であるかを確認できます。

一方、DOMDocument::saveHTML()メソッドは、現在メモリ上に構築されているDOMツリー全体を、実際のHTML形式の文字列として取得するために使用されます。こちらも引数は不要で、構築されたHTMLコンテンツを文字列として返します。このメソッドを使うことで、プログラムで作成・変更したHTML構造をファイルに保存したり、ブラウザに出力したりすることが可能になります。

サンプルコードでは、まず新しいDOMDocumentを作成し、<html>、<body>、<p>要素とテキストノードを階層的に構築しています。その後、作成したテキストノード（Dom\CharacterDataを継承）のownerDocumentプロパティにアクセスし、それが元のDOMDocumentオブジェクトと同一であることを確認しています。最後に、saveHTML()メソッドを使って、構築されたHTMLドキュメント全体の構造を文字列として出力しています。これにより、DOM操作と結果の確認方法が具体的に理解できます。

ownerDocumentプロパティは、テキストノードなどがどのDOMドキュメントに属しているかを確認する際に利用します。ノードを作成した時点で、そのドキュメントを指すため、ドキュメントツリーに追加する前でも有効です。このプロパティは読み取り専用で、直接変更できません。一方、saveHTML()メソッドは、構築したDOMツリー全体をHTML文字列として取得するために使われます。引数を指定しない場合、ドキュメント全体が出力されます。DOMDocument作成時にformatOutput = trueを設定すると、出力されるHTMLが読みやすく整形されますが、これは出力時のみの挙動で、内部のデータ構造に影響はありません。createElementやcreateTextNodeでノードを作成した後は、必ずappendChildなどでドキュメントツリーに接続しないと、期待通りのHTMLとして出力されませんので注意が必要です。

DomノードのownerDocumentを取得する


1<?php
2
3/**
4 * Dom\CharacterData::ownerDocument プロパティの使用例を示す関数。
5 * このプロパティは、指定されたノードが属する Dom\Document オブジェクトを返します。
6 * ノードがまだドキュメントに属していない場合、またはノードが Dom\Document 自体である場合は null を返します。
7 */
8function demonstrateOwnerDocument(): void
9{
10    // 1. 新しい Dom\Document オブジェクトを作成します。
11    //    これは、XMLドキュメント全体を表すルートオブジェクトです。
12    $document = new Dom\Document('1.0', 'UTF-8');
13    echo "新しい Dom\Document を作成しました。\n";
14
15    // 2. ルート要素 'example' を作成し、ドキュメントに追加します。
16    $rootElement = $document->createElement('example');
17    $document->appendChild($rootElement);
18    echo "ルート要素 '<example>' をドキュメントに追加しました。\n";
19
20    // 3. テキストノードを作成し、ルート要素に追加します。
21    //    Dom\Text は Dom\CharacterData を継承しているため、ownerDocument プロパティにアクセスできます。
22    $textNode = $document->createTextNode('これはサンプルテキストです。');
23    $rootElement->appendChild($textNode);
24    echo "テキストノード 'これはサンプルテキストです。' をルート要素に追加しました。\n";
25
26    // 4. textNode の ownerDocument プロパティにアクセスし、その値を検証します。
27    //    このプロパティは、textNode が属している Dom\Document オブジェクトを返します。
28    $ownerDocument = $textNode->ownerDocument;
29
30    echo "\ntextNode の ownerDocument プロパティにアクセスします...\n";
31
32    // 5. 取得した ownerDocument が Dom\Document のインスタンスであるか確認します。
33    if ($ownerDocument instanceof Dom\Document) {
34        echo "  - ownerDocument は Dom\Document のインスタンスです。\n";
35        // 6. 取得した ownerDocument が、最初に作成した $document オブジェクトと同一であるか確認します。
36        //    (=== はオブジェクトの同一性をチェックします)
37        if ($ownerDocument === $document) {
38            echo "  - ownerDocument は、最初に作成した元のドキュメントと同じです。\n";
39        } else {
40            echo "  - ownerDocument は、元のドキュメントとは異なります。(これは予期されない)\n";
41        }
42    } else {
43        echo "  - ownerDocument は Dom\Document のインスタンスではありません。返り値は: " .
44             (is_null($ownerDocument) ? 'null' : get_class($ownerDocument)) . "\n";
45    }
46
47    // 7. ドキュメントに追加されていない別のテキストノードを作成し、ownerDocument を確認します。
48    //    この場合、ノードはまだどのドキュメントにも属していないため、ownerDocument は null を返します。
49    $unattachedTextNode = $document->createTextNode('未所属のテキスト');
50    $unattachedOwnerDocument = $unattachedTextNode->ownerDocument;
51
52    echo "\nまだドキュメントに追加されていないノードの場合:\n";
53    if (is_null($unattachedOwnerDocument)) {
54        echo "  - 未所属のテキストノードの ownerDocument は null です。(期待通り)\n";
55    } else {
56        echo "  - 未所属のテキストノードの ownerDocument は null ではありません。(これは予期されない)\n";
57    }
58
59    echo "\nすべての処理が完了しました。\n";
60}
61
62// 関数を実行してサンプルコードの動作を確認します。
63demonstrateOwnerDocument();

PHPのDom\CharacterData::ownerDocumentプロパティは、テキストやコメントなど、文字データを持つノードがどのDOMドキュメントに属しているかを教えてくれるプロパティです。このプロパティは引数を取らず、ノードが所属するDom\Documentオブジェクトを返すか、まだどのドキュメントにも追加されていない場合はnullを返します。

サンプルコードでは、まず新しいDom\Documentを作成し、それにexampleというルート要素、そして「これはサンプルテキストです。」というテキストノードを順に追加しています。テキストノードはDom\CharacterDataを継承しているため、ownerDocumentプロパティにアクセスできます。ドキュメントに追加されたテキストノードのownerDocumentにアクセスすると、正しく最初に作成したDom\Documentオブジェクトが返され、その同一性が確認できます。これは、ノードが確かにそのドキュメントに所属していることを示します。

一方、Dom\Documentで作成されたものの、まだドキュメントツリーに追加されていない「未所属のテキスト」ノードのownerDocumentを確認すると、期待通りnullが返されることが示されています。この挙動により、ノードが現在どのドキュメントにも属していない状態であることを判断できます。このプロパティは、ノードの所属ドキュメントを把握し、関連するDOM操作を行う際に役立ちます。

ownerDocumentプロパティは、指定されたノードが属するDom\Documentオブジェクトを返します。最も重要な注意点は、ノードがまだドキュメントツリーに追加されていない場合、このプロパティはnullを返す点です。そのため、戻り値はDom\Documentオブジェクトかnullのどちらかとなるため、常にnullチェックを行って安全に利用してください。このプロパティは、Dom\TextやDom\CommentといったDom\CharacterDataを継承するクラスのインスタンスで利用でき、ノードが目的のドキュメントに正しく関連付けられているかを確認するのに役立ちます。