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

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

作成日: 2025年09月11日更新日: 2025年10月31日

基本的な使い方

ownerDocumentプロパティは、DOMDocumentFragmentオブジェクトが所属するDOMDocumentオブジェクトを保持するプロパティです。このプロパティは、XMLやHTMLドキュメントの構造を操作するためのPHPのDOM拡張機能の一部として提供されます。

DOMDocumentFragmentは、XMLやHTMLのドキュメントツリーの断片（複数のノードのまとまり）を一時的に保持するために使用される特別なノードです。これは、実際のドキュメントツリーに直接追加されるものではなく、主にパフォーマンスの最適化や、複数のノードをまとめて操作する際に利用されます。

ownerDocumentプロパティは、このDOMDocumentFragmentがどのDOMDocumentによって作成され、どのドキュメントのコンテキストで操作されるべきかを示します。例えば、DOMDocumentFragment内に新しい要素ノードを作成する場合、その新しい要素ノードはownerDocumentプロパティが指すDOMDocumentに属することになります。これにより、ドキュメントの各ノードがどのドキュメントに「所有」されているかが明確になり、異なるドキュメント間でのノードの移動やコピー、あるいは単一のドキュメント内での複雑な操作を正確に行うことが可能になります。

このプロパティを参照することで、現在のDOMDocumentFragmentと関連付けられている親ドキュメントにアクセスし、そのドキュメントのメソッドや他のノードと連携した操作を行うことができます。これは、DOMツリーを構築したり変更したりする際に、ノードの所属関係を正しく管理するために不可欠な情報です。

構文(syntax)


1<?php
2
3$dom = new DOMDocument();
4$domDocumentFragment = $dom->createDocumentFragment();
5
6$ownerDocument = $domDocumentFragment->ownerDocument;
7
8?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

DOMDocument|null

このプロパティは、このフラグメントが属するDOMDocumentオブジェクト、またはフラグメントがどのドキュメントにも関連付けられていない場合はnullを返します。

サンプルコード

DOMDocumentFragmentのownerDocumentとsaveHTML


1<?php
2
3/**
4 * DOMDocumentFragment の ownerDocument プロパティと DOMDocument::saveHTML() の使用例を示します。
5 *
6 * この関数は、DOMDocumentFragment がどの DOMDocument に属しているかを確認し、
7 * フラグメントをドキュメントに追加した後、ドキュメント全体の HTML を出力します。
8 */
9function demonstrateOwnerDocumentAndSaveHTML(): void
10{
11    // 1. 新しい DOMDocument オブジェクトを作成します。
12    // 出力時に整形を有効にします。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    $dom->formatOutput = true;
15
16    // 2. DOMDocumentFragment オブジェクトを作成します。
17    // createDocumentFragment() で作成されたフラグメントの ownerDocument は、$dom になります。
18    $fragment = $dom->createDocumentFragment();
19
20    // 3. DOMDocumentFragment に HTML コンテンツを追加します。
21    // appendXML() は、HTML 文字列をパースしてフラグメントに追加します。
22    $fragment->appendXML('<p>これはフラグメントに追加された段落です。</p><span>そしてこれはスパンです。</span>');
23
24    // 4. DOMDocumentFragment の ownerDocument プロパティにアクセスします。
25    // このプロパティは、このフラグメントが属している DOMDocument オブジェクトを返します。
26    $ownerDoc = $fragment->ownerDocument;
27
28    echo "--- ownerDocument の確認 ---" . PHP_EOL;
29    if ($ownerDoc instanceof DOMDocument) {
30        echo "DOMDocumentFragment の ownerDocument は DOMDocument オブジェクトです。" . PHP_EOL;
31        // ownerDocument が元の $dom と同じオブジェクトであることを確認します。
32        echo "ownerDocument は元の DOMDocument と " . ($ownerDoc === $dom ? "同じ" : "異なる") . " オブジェクトです。" . PHP_EOL;
33    } else {
34        echo "DOMDocumentFragment の ownerDocument は NULL です。" . PHP_EOL;
35    }
36
37    // 5. DOMDocument にルート要素 (<html><body>) を作成し、フラグメントを追加します。
38    $htmlElement = $dom->createElement('html');
39    $bodyElement = $dom->createElement('body');
40    $htmlElement->appendChild($bodyElement);
41    $dom->appendChild($htmlElement); // ドキュメントにルート要素を追加
42
43    // 作成したフラグメントをドキュメントの <body> 要素に追加します。
44    $bodyElement->appendChild($fragment);
45
46    echo PHP_EOL . "--- ドキュメント全体の HTML 出力 (saveHTML) ---" . PHP_EOL;
47    // ドキュメント全体を HTML 形式で出力します。
48    // ownerDocument プロパティが指し示す DOMDocument を使って saveHTML が機能し、
49    // フラグメントの内容がドキュメントの一部として出力されることを示します。
50    echo $dom->saveHTML();
51}
52
53// 上記の関数を実行します。
54demonstrateOwnerDocumentAndSaveHTML();

このPHPのサンプルコードは、HTMLの構造をプログラムで操作する際に使うDOMDocumentFragmentクラスのownerDocumentプロパティと、DOMDocument::saveHTML()メソッドの利用方法を初心者の方にも分かりやすく説明しています。

DOMDocumentFragmentは、HTMLの断片（例えば、複数の段落やタグのまとまり）を一時的に保持するための入れ物です。この断片が「どのDOMDocument（HTML全体の構造を管理するオブジェクト）によって生成され、最終的にその一部となるのか」を示すのがownerDocumentプロパティです。このプロパティは、通常、元のDOMDocumentオブジェクトを返しますが、状況によってはnullを返すこともあります。

コードではまず、全体のHTMLを管理するDOMDocumentを作成し、そこからcreateDocumentFragment()でDOMDocumentFragmentを生成します。この時点で、フラグメントのownerDocumentは作成元のDOMDocumentを指します。appendXML()でフラグメントにHTMLコンテンツを追加し、ownerDocumentプロパティでその参照が正しいことを確認します。その後、DOMDocumentに<html>や<body>といった基本要素を構築し、作成したフラグメントを<body>の中に追加します。

最終的に$dom->saveHTML()を呼び出すと、フラグメントの内容も統合された完全なHTMLコードが文字列として出力されます。この一連の流れは、PHPで動的にHTMLコンテンツを生成し、管理するための基本的なアプローチを示しています。

このサンプルコードは、DOMDocumentFragment::ownerDocumentプロパティが、フラグメントがどのDOMDocumentに属するかを示すことを解説しています。$dom->createDocumentFragment()で生成したフラグメントのownerDocumentは、その$domオブジェクトを指します。一方で、new DOMDocumentFragment()のように直接インスタンスを作成した場合、ownerDocumentはnullとなる可能性があるため、どのDOMDocumentに属させるかを意識することが重要です。DOMDocumentFragmentは、複数のノードをまとめて一時的に保持するコンテナとして便利です。これをドキュメントへ追加すると、フラグメント自体ではなく、その内部のノードが展開されて挿入されます。DOMDocument::saveHTML()でドキュメント全体をHTML出力する際は、事前に<html>や<body>などの適切な構造をDOMDocument内に構築しておくことで、完全なHTMLドキュメントとして出力できます。

DOMDocumentFragmentのownerDocumentを取得する


1<?php
2
3/**
4 * DOMDocumentFragment の ownerDocument プロパティの使用例を示します。
5 * ownerDocument プロパティは、そのノードが属する DOMDocument オブジェクトを返します。
6 * フラグメントがどのドキュメントにも関連付けられていない場合は null を返します。
7 */
8function demonstrateDomFragmentOwnerDocument(): void
9{
10    echo "--- ケース1: DOMDocumentFragment を直接インスタンス化した場合 ---\n";
11    // DOMDocumentFragment を直接 'new' でインスタンス化した場合、
12    // まだどの DOMDocument にも追加されていないため、ownerDocument は null です。
13    $fragment1 = new DOMDocumentFragment();
14
15    echo "直接インスタンス化されたフラグメントの ownerDocument: ";
16    if ($fragment1->ownerDocument === null) {
17        echo "null (想定通り)\n";
18    } else {
19        // 通常このケースでDOMDocumentオブジェクトが返されることはありません
20        echo "DOMDocument オブジェクト (想定外)\n";
21    }
22
23    echo "\n--- ケース2: DOMDocument::createDocumentFragment() で作成した場合 ---\n";
24    // 新しい DOMDocument を作成します。これがフラグメントの「所有者」ドキュメントとなります。
25    $document = new DOMDocument('1.0', 'UTF-8');
26    $document->formatOutput = true; // 出力を見やすく整形
27
28    // ルート要素を作成しドキュメントに追加します。
29    // (ownerDocument の確認自体には必須ではありませんが、ドキュメントの存在を示すため)
30    $rootElement = $document->createElement('root');
31    $document->appendChild($rootElement);
32
33    // DOMDocument::createDocumentFragment() を使用してフラグメントを作成します。
34    // この方法で作成されたフラグメントは、作成元の $document を ownerDocument として持ちます。
35    $fragment2 = $document->createDocumentFragment();
36
37    // フラグメント内に要素を追加します。(ownerDocument の確認には必須ではありません)
38    $childElement = $document->createElement('item', 'これはフラグメント内の要素です。');
39    $fragment2->appendChild($childElement);
40
41    echo "DOMDocument::createDocumentFragment() で作成されたフラグメントの ownerDocument: ";
42    if ($fragment2->ownerDocument instanceof DOMDocument) {
43        echo "DOMDocument オブジェクト\n";
44        echo "  - 取得した ownerDocument のルート要素名: " . ($fragment2->ownerDocument->documentElement ? $fragment2->ownerDocument->documentElement->tagName : 'なし') . "\n";
45        // ownerDocument が元の $document と同じオブジェクトであるかを確認します。
46        if ($fragment2->ownerDocument === $document) {
47            echo "  - これは元の DOMDocument と同じインスタンスです。(想定通り)\n";
48        } else {
49            echo "  - これは元の DOMDocument とは異なるインスタンスです。(想定外)\n";
50        }
51    } elseif ($fragment2->ownerDocument === null) {
52        // 通常、このケースで null が返されることはありません
53        echo "null (想定外)\n";
54    }
55
56    echo "\n--- フラグメントの内容をドキュメントに追加する例 (参考) ---\n";
57    // 作成したフラグメントの内容をルート要素に追加します。
58    $rootElement->appendChild($fragment2);
59    echo "フラグメントの内容をドキュメントに追加しました。\n";
60    echo "現在のドキュメント内容:\n";
61    echo $document->saveXML();
62}
63
64// 関数の実行
65demonstrateDomFragmentOwnerDocument();

PHPのDOMDocumentFragmentクラスにあるownerDocumentプロパティは、そのノードがどのDOMDocumentオブジェクトに属しているかを示すために利用されます。このプロパティは引数を必要としません。

戻り値としては、フラグメントが既存のDOMドキュメントに紐付けられている場合はそのDOMDocumentオブジェクトが返されます。もし、まだどのドキュメントにも関連付けられていない場合はnullが返されます。

具体的な挙動として、new DOMDocumentFragment()のようにフラグメントを直接インスタンス化した直後は、まだ特定のDOMドキュメントに追加されていないため、ownerDocumentプロパティはnullを返します。これは、フラグメントがどのドキュメントの「所有物」でもない状態を示します。

一方で、DOMDocumentクラスのcreateDocumentFragment()メソッドを使ってフラグメントを作成すると、そのフラグメントは作成元のDOMDocumentオブジェクトに紐付けられます。この場合、ownerDocumentプロパティは、フラグメントを作成した元のDOMDocumentオブジェクトのインスタンスを返します。これにより、フラグメントがどのドキュメントによって生成され、関連付けられているかをプログラムで確認でき、フラグメントとドキュメントの関係性を理解し、操作する上で重要な情報を提供します。

DOMDocumentFragmentのownerDocumentプロパティは、そのフラグメントがどのDOMDocumentに属しているかを示す重要な情報です。直接new DOMDocumentFragment()でインスタンス化した場合、初期状態ではどのドキュメントにも関連付けられていないため、ownerDocumentはnullを返します。一方、DOMDocument::createDocumentFragment()メソッドで作成したフラグメントは、作成元のDOMDocumentオブジェクトをownerDocumentとして保持します。これにより、フラグメントが特定のドキュメントのコンテキストで生成されたことを示します。安全にDOM操作を行うためには、ownerDocumentがnullか、意図したDOMDocumentインスタンスであるかを常に確認することが重要です。