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

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

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

基本的な使い方

ownerDocumentプロパティは、DOMTextオブジェクトが属するドキュメント（DOMDocumentオブジェクト）を保持するプロパティです。

PHPのDOM拡張機能は、HTMLやXMLといったマークアップ言語の文書構造をプログラムから操作するための機能を提供します。この文書構造は「Document Object Model（DOM）」と呼ばれ、ツリー状のデータ構造で表現されます。DOMTextクラスは、このDOMツリーを構成する要素の一つで、HTMLタグやXMLタグの内容として存在する純粋なテキストを表すノードです。

ownerDocumentプロパティは、特定のDOMTextオブジェクトが、どのDOMDocumentオブジェクトによって「所有されている」のか、つまり、どのHTMLやXML文書の一部であるのかを示す役割を持ちます。例えば、あるテキストノードを操作している際に、そのテキストが存在する文書全体に対して、新しい要素を追加したり、文書の別の部分を変更したりする必要が生じることがあります。そのような場合に、このownerDocumentプロパティを利用することで、対象となる文書のルートオブジェクトであるDOMDocumentインスタンスに簡単にアクセスできます。

このプロパティは、常にDOMDocument型のオブジェクトを返します。これは、DOMTextオブジェクトが属している文書そのものです。ownerDocumentプロパティは読み取り専用であり、その値を直接変更することはできません。文書構造を正しく理解し、DOMツリー内のノードと文書全体の関連性を把握するために不可欠なプロパティの一つです。

構文(syntax)


1<?php
2$dom = new DOMDocument('1.0', 'UTF-8');
3$textNode = $dom->createTextNode('Sample Text');
4
5$ownerDocumentObject = $textNode->ownerDocument;
6
7echo $ownerDocumentObject->xmlVersion;
8?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

DOMDocument|null

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

サンプルコード

DOMTextからownerDocumentでHTMLを取得する


1<?php
2
3// システムエンジニアを目指す初心者の方へ：
4// このコードは、HTMLドキュメントのテキスト部分（DOMText）から、
5// そのテキストが属している元のドキュメント全体（DOMDocument）を取得し、
6// そのドキュメントの内容をHTML文字列として出力する方法を示します。
7
8// 1. DOMDocumentオブジェクトを作成し、HTMLコンテンツをロードします。
9//    DOMDocumentはHTMLやXMLドキュメントをオブジェクトとして扱うためのクラスです。
10$dom = new DOMDocument();
11// HTML文字列をDOMDocumentオブジェクトにロードします。
12// LIBXML_HTML_NOIMPLIEDとLIBXML_HTML_NODEFDTDは、
13// 余分な<html>や<body>タグ、DOCTYPE宣言が自動挿入されるのを防ぐためのオプションです。
14$dom->loadHTML('
15    <!DOCTYPE html>
16    <html>
17    <head>
18        <title>DOM Example</title>
19    </head>
20    <body>
21        <h1>Hello PHP DOM!</h1>
22        <p>This is a <span>sample</span> text for ownerDocument demonstration.</p>
23        <p>Another paragraph.</p>
24    </body>
25    </html>
26', LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
27
28// 2. ドキュメント内の特定の要素（ここでは最初の<p>タグ）を取得します。
29$paragraphs = $dom->getElementsByTagName('p');
30
31// 3. 最初の<p>要素が存在するか確認します。
32if ($paragraphs->length > 0) {
33    $firstParagraph = $paragraphs->item(0);
34
35    // 4. <p>要素の最初の子ノードがテキストノードであることを確認します。
36    //    この場合、「This is a 」の部分がテキストノードになります。
37    if ($firstParagraph instanceof DOMNode && $firstParagraph->firstChild instanceof DOMText) {
38        $textNode = $firstParagraph->firstChild;
39
40        echo "--- Original Text Node Content ---\n";
41        echo "Value: \"" . $textNode->nodeValue . "\"\n\n";
42
43        // 5. DOMText::ownerDocument プロパティを使用して、
44        //    このテキストノードが属する元のDOMDocumentオブジェクトを取得します。
45        //    これにより、どのドキュメントにこのテキストノードが存在するかを知ることができます。
46        $ownerDocument = $textNode->ownerDocument;
47
48        echo "--- Retrieved Owner Document HTML ---\n";
49        // 6. 取得したDOMDocumentオブジェクトが存在する場合、
50        //    saveHTML() メソッドでドキュメント全体のHTMLを文字列として出力します。
51        //    saveHTML()は、現在のDOMDocumentオブジェクトが保持するHTMLツリー全体を表現します。
52        if ($ownerDocument) {
53            echo $ownerDocument->saveHTML();
54        } else {
55            echo "Error: Owner Document could not be retrieved.\n";
56        }
57    } else {
58        echo "Error: The first child of the first paragraph is not a DOMText node.\n";
59    }
60} else {
61    echo "Error: No paragraph elements found in the document.\n";
62}
63
64?>

このPHPサンプルコードは、HTMLドキュメントの構造を操作するDOM（Document Object Model）の基本的な使い方と、特定のノードから元のドキュメント全体を取得する方法を示しています。まず、DOMDocumentクラスを使用してHTML文字列をメモリ上にロードし、そのHTMLをオブジェクトとして扱えるように準備します。次に、ロードされたドキュメントの中から特定の要素とその中のテキストノードを取得します。

DOMText::ownerDocumentプロパティは、取得したテキストノード（DOMTextクラスのインスタンス）がどのDOMDocumentオブジェクトに属しているかを知るために使用されます。このプロパティは引数を取らず、戻り値としてそのテキストノードを所有するDOMDocumentオブジェクト、または存在しない場合はnullを返します。これにより、ドキュメント内の部分的なノードから、そのノードが属する元のドキュメント全体へと遡ることが可能になります。

さらに、ownerDocumentプロパティで取得したDOMDocumentオブジェクトのsaveHTML()メソッドを使うことで、元のドキュメント全体の内容をHTML文字列として出力できます。saveHTML()は、現在のDOMDocumentオブジェクトが保持するHTMLツリー全体を表現する文字列を生成し、ブラウザで表示されるような完全なHTML構造を再構築します。この一連の操作は、HTMLコンテンツの解析や変換、特定の箇所を抽出する際などに役立ちます。

ownerDocumentプロパティは、ノードが属するDOMDocumentオブジェクトを返しますが、状況によってはnullを返す可能性があるため、常にnullチェックを行ってから利用してください。saveHTML()メソッドは、引数なしで呼び出すとDOMDocumentオブジェクト全体のHTMLを文字列として出力します。もし特定のノードのHTMLだけが必要な場合は、saveHTML($node)のように引数にそのノードを指定することで、そのノード以下のHTMLを生成できます。DOMDocument::loadHTML()でHTMLを読み込む際には、不完全なマークアップがDOMツリーに意図しない影響を与える可能性があるため、適切なエラーハンドリングを考慮してください。また、getElementsByTagName()などでノードを取得する際は、必ずlengthプロパティで存在を確認し、instanceofでノードの型を確認することで、予期せぬ実行時エラーを防ぐようにしましょう。

DOMText の ownerDocument を取得する


1<?php
2
3/**
4 * DOMText::ownerDocument プロパティの使用例
5 *
6 * このスクリプトは、DOMText ノードがどの DOMDocument に属しているかを示す
7 * ownerDocument プロパティの動作を実演します。
8 * ownerDocument は、そのノードを作成した、または現在属している DOMDocument オブジェクトを返します。
9 */
10
11// 1. 新しい DOMDocument を作成します。
12//    XML バージョンとエンコーディングを指定します。
13$document = new DOMDocument('1.0', 'UTF-8');
14
15// 出力を見やすくするために、フォーマットを有効にします。
16$document->formatOutput = true;
17
18// 2. ルート要素を作成し、ドキュメントに追加します。
19//    テキストノードを保持する親として機能します。
20$rootElement = $document->createElement('data');
21$document->appendChild($rootElement);
22
23// 3. テキストノードを作成します。
24//    この時点では、このテキストノードはまだドキュメントツリーに追加されていません。
25$textNode = $document->createTextNode('これはサンプルテキストです。');
26
27// 4. 作成したテキストノードをルート要素に追加します。
28//    これで、テキストノードは $document の一部となります。
29$rootElement->appendChild($textNode);
30
31// 5. DOMText ノードの ownerDocument プロパティにアクセスします。
32//    このプロパティは、テキストノードが属する DOMDocument オブジェクトを返します。
33$ownerDocFromText = $textNode->ownerDocument;
34
35// 6. 結果を表示して確認します。
36//    spl_object_id() を使用して、オブジェクトのユニークなIDを表示し、
37//    元の $document と $ownerDocFromText が同じオブジェクトであるかを確認します。
38echo "元の DOMDocument オブジェクトのID: " . spl_object_id($document) . PHP_EOL;
39echo "DOMText の ownerDocument オブジェクトのID: " . spl_object_id($ownerDocFromText) . PHP_EOL;
40
41if ($ownerDocFromText === $document) {
42    echo "=> DOMText の ownerDocument は、元の DOMDocument と同じオブジェクトを参照しています。" . PHP_EOL;
43} else {
44    echo "=> DOMText の ownerDocument は、元の DOMDocument と異なるオブジェクトを参照しています。" . PHP_EOL;
45}
46
47// (オプション) 作成された XML ドキュメントの内容を表示します。
48// echo PHP_EOL . "生成されたXMLドキュメント:" . PHP_EOL;
49// echo $document->saveXML();
50
51?>

DOMText::ownerDocumentプロパティは、XMLなどの文書構造を扱う際に使用されるDOMTextオブジェクトが、どのDOMDocumentオブジェクトに属しているかを示すためのものです。このプロパティは引数を取らず、そのテキストノードを作成した、または現在属しているDOMDocumentオブジェクトを返します。もしノードがまだどのドキュメントツリーにも追加されていない場合は、nullを返す可能性があります。

サンプルコードでは、まず新しいDOMDocumentを作成し、その中にルート要素とDOMTextノードを作成・追加しています。その後、作成したDOMTextオブジェクトからownerDocumentプロパティにアクセスすることで、このテキストノードが属するDOMDocumentオブジェクトを取得しています。spl_object_id()関数を用いて、取得したownerDocumentが、最初に作成したDOMDocumentと全く同じオブジェクトであることを確認しており、テキストノードとそれが属する文書との関連性を明確に理解することができます。このプロパティは、特定のノードがどの文書に紐づいているかを判断し、それに応じた処理を行う際に非常に役立ちます。

DOMText::ownerDocumentプロパティは、テキストノードがどのDOMDocumentオブジェクトに属しているかを示します。サンプルコードのようにノードがドキュメントツリーに追加されている場合、そのノードを作成したDOMDocumentオブジェクトそのものが返されるため、元のDOMDocumentと厳密に同じオブジェクトとなります。そのため、spl_object_id()で確認するとオブジェクトIDも一致し、===演算子で比較するとtrueになります。

重要な注意点として、このプロパティは常にDOMDocumentオブジェクトを返すわけではありません。もしノードがまだどのDOMDocumentにも追加されていない、あるいはDOMDocumentFragmentに属している場合など、状況によってはnullを返すことがあります。そのため、ownerDocumentの値を利用する際は、必ずnullチェックを行い、オブジェクトが存在することを確認してから操作するようにしましょう。これにより、予期せぬエラーを防ぎ、より堅牢なコードになります。