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

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

作成日: 2025年09月11日更新日: 2025年12月02日

基本的な使い方

ownerDocumentプロパティは、所属クラスであるDom\DocumentTypeインスタンスが属しているDom\Documentオブジェクトを保持するプロパティです。

PHPのDOM拡張機能は、HTMLやXMLのようなマークアップ文書の構造をプログラムから操作するための標準的な方法を提供します。Dom\DocumentTypeクラスは、これらの文書の先頭に記述される<!DOCTYPE html>のようなドキュメント型宣言を表すものです。

このownerDocumentプロパティは、特定のDom\DocumentTypeノードが、具体的にどのHTMLまたはXML文書に属しているのかを特定するために使用されます。例えば、文書型宣言のノードだけが手元にある状態で、その宣言が組み込まれている文書全体のDOMツリーのルートであるDom\Documentオブジェクトにアクセスしたい場合に非常に役立ちます。

プロパティにアクセスすることで、Dom\DocumentTypeノードから、そのノードの親である文書ノードを取得できます。これにより、文書全体への参照を得て、文書の他の部分を操作したり、情報を取得したりする起点とすることが可能です。これは、DOMツリー内の任意のノードが、どの文書コンテキストに存在しているかを理解するための標準的なメカニズムであり、開発者がノードと文書の関係性を把握する上で重要な役割を果たします。返される値は、常にDom\Documentクラスのインスタンスとなります。

構文(syntax)


1<?php
2
3// Dom\Document クラスのインスタンスを作成し、DOCTYPE宣言を含むXMLをロードします。
4$document = new Dom\Document();
5$document->loadXML('<!DOCTYPE root SYSTEM "system.dtd"><root/>');
6
7// DocumentのdoctypeプロパティからDom\DocumentTypeオブジェクトを取得します。
8$documentTypeNode = $document->doctype;
9
10// Dom\DocumentType オブジェクトの ownerDocument プロパティにアクセスし、
11// このノードが属する Dom\Document オブジェクトを取得します。
12$owningDocument = $documentTypeNode->ownerDocument;
13
14?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

Dom\Document|null

このプロパティは、この Dom\DocumentType ノードが属する Dom\Document オブジェクトを返します。もしノードが Dom\Document に直接関連付けられていない場合は null を返します。

サンプルコード

Dom\DocumentType::ownerDocument からHTMLを出力する


1<?php
2
3/**
4 * Dom\DocumentType::ownerDocument プロパティと Dom\Document::saveHTML メソッドの使用例を示します。
5 *
6 * この関数は、新しいDOMドキュメントを作成し、それにDOCTYPEを追加します。
7 * 次に、追加されたDOCTYPEからその所有ドキュメント（ownerDocument）を取得し、
8 * 最後にそのドキュメントの内容をHTML形式で出力します。
9 */
10function demonstrateOwnerDocumentAndSaveHtml(): void
11{
12    // 1. 新しいDom\Documentインスタンスを作成します。
13    //    これはXML/HTMLドキュメントの全体を表現するオブジェクトです。
14    $dom = new \Dom\Document('1.0', 'UTF-8');
15    // 出力を読みやすくするために整形を有効にします。
16    $dom->formatOutput = true;
17
18    // 2. Dom\DocumentTypeオブジェクトを作成します。
19    //    これはHTMLの<!DOCTYPE html>のような宣言を表します。
20    $implementation = new \Dom\DOMImplementation();
21    $doctype = $implementation->createDocumentType('html', '', ''); // HTML5のDOCTYPEを作成
22
23    // 3. 作成したDOCTYPEをDom\Documentに追加します。
24    //    DOCTYPEは通常、ドキュメントの最初のノードとして配置されます。
25    $dom->appendChild($doctype);
26
27    // 4. Dom\DocumentTypeのownerDocumentプロパティにアクセスします。
28    //    このプロパティは、このDOCTYPEが属するDom\Documentオブジェクトを返します。
29    $ownerDocument = $doctype->ownerDocument;
30
31    // 5. 取得したownerDocumentが期待通りDom\Documentのインスタンスであることを確認し、
32    //    その内容をHTML形式で出力します。
33    if ($ownerDocument instanceof \Dom\Document) {
34        echo "Dom\\DocumentType::ownerDocument プロパティから親ドキュメントが正常に取得されました。\n\n";
35        echo "取得された親ドキュメントのHTML内容:\n";
36        // ownerDocumentのsaveHTML()メソッドを使用して、ドキュメント全体のHTMLを文字列として取得し出力します。
37        echo $ownerDocument->saveHTML();
38    } else {
39        echo "エラー: ownerDocument が Dom\\Document のインスタンスではありませんでした。\n";
40    }
41}
42
43// 上記の関数を実行して、サンプルコードを動作させます。
44demonstrateOwnerDocumentAndSaveHtml();

このサンプルコードは、PHPのDOM（Document Object Model）操作において、Dom\DocumentTypeオブジェクトからその親ドキュメント（Dom\Document）を取得する方法と、そのドキュメントの内容をHTML形式で出力する方法を示しています。

具体的には、まずDom\Documentクラスのインスタンスを作成し、これがXMLやHTMLドキュメント全体を表現します。次に、Dom\DOMImplementationを使用して<!DOCTYPE html>のようなDOCTYPE宣言（Dom\DocumentTypeオブジェクト）を作成し、作成したドキュメントに追加します。

ここで中心となるのがDom\DocumentType::ownerDocumentプロパティです。このプロパティは引数を取らず、このDOCTYPEが属しているDom\Documentオブジェクトを返します。もし親ドキュメントが存在しない場合はnullを返します。サンプルでは、追加した$doctypeオブジェクトからownerDocumentプロパティを使って親ドキュメントを取得しています。

最後に、取得した親ドキュメントが正しくDom\Documentインスタンスであることを確認した上で、Dom\Document::saveHTML()メソッドを使用しています。このメソッドも引数はなく、現在のDOMドキュメント全体をHTML文字列として返します。これにより、作成したドキュメント（DOCTYPEを含む）の内容がHTML形式で出力されることを確認できます。

Dom\DocumentType::ownerDocumentプロパティは、対象のDOCTYPEが所属するDom\Documentオブジェクトを返します。このプロパティは、ノードがまだドキュメントに追加されていない場合などにはnullを返す可能性があるため、サンプルコードのようにinstanceof演算子で戻り値の型を必ず確認してください。Dom\Document::saveHTMLメソッドは、ドキュメント全体の内容をHTML文字列として出力するものであり、特定の要素だけをHTML化するものではないことに注意が必要です。また、$dom->formatOutput = true; は開発中のコードの可読性を高めますが、本番環境ではパフォーマンスに影響を与える可能性があるため、設定には慎重な検討が必要です。DOM操作では、ノードの追加や変更時に意図しないエラーが発生することもあるため、適切なエラーハンドリングを心がけてください。

DocumentTypeのownerDocumentを取得する


1<?php
2
3/**
4 * Dom\DocumentType::ownerDocument プロパティの使用例を示します。
5 * このプロパティは、Dom\DocumentType ノードが属する Dom\Document オブジェクトを返します。
6 * システムエンジニアを目指す初心者向けに、HTML ドキュメントを解析し、
7 * ドキュメントタイプノードとその所有者ドキュメントの関係を説明します。
8 */
9function demonstrateOwnerDocumentProperty(): void
10{
11    // 1. サンプルHTML文字列を準備します。
12    // <!DOCTYPE html> は Dom\DocumentType ノードを生成するために重要です。
13    $htmlContent = '<!DOCTYPE html>
14<html>
15<head>
16    <title>サンプルドキュメント</title>
17</head>
18<body>
19    <h1>こんにちは、DOM!</h1>
20    <p>これは、Dom\Document の所有者ドキュメントのデモです。</p>
21</body>
22</html>';
23
24    // 2. 新しい Dom\Document オブジェクトを作成し、HTMLを読み込みます。
25    $document = new Dom\Document();
26    // HTMLの構文解析中に発生した警告を表示しないようにします。
27    libxml_use_internal_errors(true);
28    $document->loadHTML($htmlContent);
29    libxml_clear_errors(); // 警告をクリアします。
30
31    echo "--- Dom\DocumentType::ownerDocument プロパティのデモ ---\n\n";
32
33    // 3. ドキュメントから Dom\DocumentType ノードを取得します。
34    // Dom\Document::doctype プロパティは、ドキュメントの Doctype ノードを返します。
35    $documentType = $document->doctype;
36
37    // Dom\DocumentType ノードが見つかったかどうかを確認します。
38    if ($documentType instanceof Dom\DocumentType) {
39        echo "Dom\DocumentType ノードが見つかりました。\n";
40        echo "ドキュメントタイプ名: " . $documentType->name . "\n";
41        echo "公開識別子 (publicId): " . ($documentType->publicId ?: '(なし)') . "\n";
42        echo "システム識別子 (systemId): " . ($documentType->systemId ?: '(なし)') . "\n\n";
43
44        // 4. Dom\DocumentType ノードの ownerDocument プロパティにアクセスします。
45        // これは、この DocumentType ノードが属する Dom\Document オブジェクトを返します。
46        $ownerDocument = $documentType->ownerDocument;
47
48        // ownerDocument が、元々HTMLを読み込んだ $document と同じオブジェクトであるかを確認します。
49        if ($ownerDocument === $document) {
50            echo "Dom\DocumentType の ownerDocument は、元の Dom\Document と同じオブジェクトです。\n";
51            echo "これは、Dom\DocumentType がどのドキュメントに属しているかを示しています。\n\n";
52
53            // 確認のために、元のドキュメントと所有者ドキュメントの情報を比較します。
54            echo "元の Dom\Document のノード数: " . $document->childNodes->count() . "\n";
55            echo "ownerDocument のノード数: " . $ownerDocument->childNodes->count() . "\n";
56            // ノード数は同じであるはずです。
57        } else {
58            echo "エラー: Dom\DocumentType の ownerDocument が元の Dom\Document と一致しません。\n";
59            // 通常、このケースは発生しません。
60        }
61    } else {
62        echo "Dom\DocumentType ノードが見つかりませんでした。\n";
63        echo "これは、HTMLコンテンツに <!DOCTYPE html> のような doctype 宣言が含まれていない場合に発生します。\n";
64    }
65
66    echo "\n------------------------------------------------------\n";
67}
68
69// デモンストレーション関数を実行します。
70demonstrateOwnerDocumentProperty();
71

PHPのDom\DocumentType::ownerDocumentプロパティは、DOM（Document Object Model）を扱う際、特定のDom\DocumentTypeノードがどのDom\Documentオブジェクトに属しているかを示します。

このプロパティを使うには、まずDom\DocumentクラスでHTMLやXML文字列を解析し、ドキュメントのDOMツリーを構築します。HTMLに<!DOCTYPE html>のようなドキュメントタイプ宣言があれば、Dom\Document::doctypeプロパティを通じてDom\DocumentTypeノードを取得できます。

取得したDom\DocumentTypeノードのownerDocumentプロパティにアクセスすると、そのノードが属する「所有者ドキュメント」であるDom\Documentオブジェクトが得られます。引数はなく、戻り値はDom\Documentオブジェクト、またはノードがドキュメントに未関連付けの場合はnullです。これにより、各ノードがどのドキュメントのコンテキストに存在するかを正確に把握でき、システムエンジニアがDOM構造を理解する上で役立ちます。

Dom\DocumentType::ownerDocumentプロパティは、そのDom\DocumentTypeノードがどのDom\Documentオブジェクトに属しているかを示します。サンプルコードのように<!DOCTYPE html>のような宣言がHTML内にある場合にのみDom\DocumentTypeノードは存在します。そのため、$document->doctypeがnullである可能性を考慮し、プロパティにアクセスする前にinstanceof Dom\DocumentTypeで型をチェックすることが重要です。また、ownerDocumentプロパティ自体もDom\Documentまたはnullを戻り値とするため、取得後にはnullでないことを確認してから利用すると、より安全なコードになります。このプロパティは、DOMツリー内で特定のノードがどのドキュメントの一部であるかを確認する際に役立ちます。libxml_use_internal_errors(true)はHTML解析中の警告を抑え、安定した処理に寄与しますが、問題調査時には警告表示を有効にすると良いでしょう。