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

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

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

基本的な使い方

『ownerDocumentプロパティは、現在の処理命令（Processing Instruction）ノードが属しているドキュメント全体を表すDom\Documentオブジェクトを保持するプロパティです。XMLやHTML文書をプログラム上で扱う際、個々のノードは特定の文書ツリーの一部として存在します。このプロパティは、現在の処理命令ノードがどの文書に所属しているかへの参照を提供します。これにより、あるノードから文書全体の操作へアクセスすることが可能になります。例えば、このプロパティを通じて得られるDom\Documentオブジェクトを起点として、文書内に新しい要素を作成したり、特定のIDを持つ要素を検索したりできます。ただし、createProcessingInstructionメソッドなどでノードが作成されただけで、まだ文書ツリーのどこにも追加されていない場合、このプロパティの値はnullになります。これは、ノードがどの文書にも属していない状態を示しています。また、このプロパティは読み取り専用であるため、直接値を代入して所属ドキュメントを変更することはできません。』

構文(syntax)


1<?php
2
3$document = new \Dom\Document();
4
5$pi = $document->createProcessingInstruction('xml-stylesheet', 'href="style.css" type="text/css"');
6
7// ProcessingInstructionノードが属するDocumentオブジェクトを取得します。
8$ownerDocument = $pi->ownerDocument;
9
10// $ownerDocumentプロパティは、元の$documentオブジェクトを返します。
11var_dump($ownerDocument === $document);
12
13?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

?Dom\Document

このプロパティは、この処理命令ノードが属する Dom\Document オブジェクトへの参照を返します。もしノードがまだドキュメントにアタッチされていない場合は null を返します。

サンプルコード

ownerDocumentでドキュメントを取得しsaveHTMLする


1<?php
2
3/**
4 * Dom\ProcessingInstruction の ownerDocument プロパティと
5 * Dom\Document の saveHTML メソッドの使用例を示します。
6 *
7 * ownerDocument プロパティは、任意のノードが属する Dom\Document オブジェクトを返します。
8 * saveHTML メソッドは、Dom\Document の内容全体をHTML文字列として出力します。
9 *
10 * このコードは、HTMLドキュメントを作成し、処理命令を追加した後、
11 * その処理命令が属するドキュメント全体をHTMLとして出力する手順を説明します。
12 */
13function demonstrateDomOwnerDocumentAndSaveHtml(): void
14{
15    // 新しいDOMドキュメントオブジェクトを作成します。
16    $dom = new Dom\Document();
17
18    // HTMLコンテンツをロードします。
19    // 適切なHTML構造を持つ最小限のドキュメントを用意します。
20    $dom->loadHTML('<!DOCTYPE html><html><head><title>サンプル</title></head><body><h1>こんにちは！</h1></body></html>');
21
22    // 処理命令ノードを作成します。
23    // これはXML/HTMLドキュメント内で、処理プログラムへの命令などを表現します。
24    // 例: <?target data?>
25    // ここでは、"app_specific" というターゲットと "action=process" というデータを持ちます。
26    $processingInstruction = $dom->createProcessingInstruction('app_specific', 'action=process');
27
28    // 作成した処理命令ノードをドキュメントの<body>タグの最初の子として追加します。
29    // ドキュメントツリーへの追加後、ownerDocumentプロパティが有効になります。
30    $body = $dom->getElementsByTagName('body')->item(0);
31    if ($body instanceof Dom\Element) {
32        $body->prepend($processingInstruction);
33    }
34
35    // 処理命令ノードが属する Dom\Document オブジェクトを取得します。
36    // ownerDocument プロパティは、ノードがどのドキュメントに属しているかを示します。
37    // 戻り値は ?Dom\Document (Dom\Document または null) です。
38    $ownerDocument = $processingInstruction->ownerDocument;
39
40    // 取得したドキュメントが有効な Dom\Document オブジェクトであることを確認します。
41    if ($ownerDocument instanceof Dom\Document) {
42        echo "--- ドキュメント全体をHTMLとして保存 (ownerDocumentから取得) ---\n";
43        // ドキュメントの内容全体をHTML文字列として保存し、出力します。
44        // これにより、追加した処理命令を含むドキュメント全体のHTML構造を確認できます。
45        echo $ownerDocument->saveHTML();
46    } else {
47        echo "エラー: ownerDocumentプロパティからDom\Documentオブジェクトが取得できませんでした。\n";
48    }
49}
50
51// 関数を実行して、Dom\ProcessingInstruction の ownerDocument プロパティと
52// Dom\Document の saveHTML メソッドの動作を確認します。
53demonstrateDomOwnerDocumentAndSaveHtml();

このPHPのサンプルコードは、DOM（Document Object Model）操作において、Dom\ProcessingInstructionクラスのownerDocumentプロパティと、Dom\DocumentクラスのsaveHTMLメソッドの利用方法を示しています。Dom\ProcessingInstructionは、XMLやHTMLドキュメント内に、アプリケーション固有の処理命令などを記述するためのノードです。

ownerDocumentプロパティは、任意のDOMノード（この例では処理命令ノード）が「どのDom\Documentオブジェクトに属しているか」を取得するために使用します。ノードがドキュメントツリーに追加された後にこのプロパティを参照すると、そのノードが元々属するDom\Documentオブジェクトが返されます。戻り値は?Dom\Document型で、これはDom\Documentオブジェクトか、あるいはnullのどちらかを返す可能性があることを意味します。

一方、saveHTMLメソッドは、Dom\Documentオブジェクトが現在保持している内容全体を、整形されたHTML文字列として出力します。このメソッドには引数がなく、呼び出すだけで現在のドキュメントのHTML構造全体を文字列として取得できます。

サンプルコードでは、まず新しいHTMLドキュメントを作成し、そこに処理命令ノードを追加しています。具体的には、<body>タグの先頭に<?app_specific action=process?>という処理命令を挿入します。その後、挿入した処理命令ノードのownerDocumentプロパティを使って、そのノードが属するDom\Documentオブジェクトを再度取得しています。最後に、取得したドキュメントオブジェクトに対してsaveHTMLメソッドを呼び出し、処理命令を含むドキュメント全体のHTML構造を文字列として画面に出力しています。これにより、ドキュメント内の個別のノードから、そのノードを含むドキュメント全体のHTML内容を効率的に確認できることがわかります。

Dom\ProcessingInstruction の ownerDocument プロパティは、ノードが属するDom\Documentオブジェクトを返しますが、そのノードのオーナーシップが確定していない場合やドキュメントから離脱している場合はnullを返す可能性があります。そのため、戻り値が必ずDom\Documentインスタンスであるかinstanceofで確認し、nullを想定した処理を記述してください。Dom\DocumentのsaveHTMLメソッドは、ドキュメント全体をHTML文字列として出力します。特定のノードや一部のHTMLのみが必要な場合は、他のメソッド（例: saveXML()）やノードを対象としたHTML生成方法を検討するなど、目的に応じた適切な方法を選択してください。また、文字エンコーディングの扱いはDom関連で問題となりやすいため、UTF-8などの特定のエンコーディングを扱う際は、Dom\DocumentのコンストラクタやloadHTMLメソッドで明示的に指定することを推奨します。

ProcessingInstruction の ownerDocument を取得する


1<?php
2
3/**
4 * Dom\ProcessingInstruction::ownerDocument プロパティの使用例を示します。
5 *
6 * この関数は、XMLドキュメント内で処理命令ノードを作成し、
7 * そのノードが属するDom\Documentオブジェクト（オーナードキュメント）を
8 * ownerDocumentプロパティを通じて取得する方法を実演します。
9 */
10function demonstrateProcessingInstructionOwnerDocument(): void
11{
12    // 1. 新しいDOMドキュメントオブジェクトを作成します。
13    // これは、これから作成するノードの「オーナー」となるドキュメントです。
14    $document = new Dom\Document('1.0', 'UTF-8');
15    $document->formatOutput = true; // 出力を見やすくするために整形を有効にします。
16
17    // 2. ドキュメントにルート要素を追加します。
18    // 処理命令は通常、ドキュメント宣言の直後やルート要素の前に配置されます。
19    $rootElement = $document->createElement('bookstore');
20    $document->appendChild($rootElement);
21
22    // 3. 新しい処理命令ノードを作成します。
23    // createProcessingInstruction() メソッドを使用して、
24    // ドキュメント（$document）がこのノードのオーナーとなります。
25    $processingInstruction = $document->createProcessingInstruction('xml-stylesheet', 'type="text/xsl" href="style.xsl"');
26
27    // 4. 処理命令ノードをドキュメントツリーに追加します。
28    // ここでは、ルート要素の前に挿入します。
29    $document->insertBefore($processingInstruction, $rootElement);
30
31    // 5. 処理命令ノードの ownerDocument プロパティにアクセスします。
32    // このプロパティは、このノードが属している Dom\Document オブジェクトを返します。
33    $ownerDocument = $processingInstruction->ownerDocument;
34
35    echo "=== Dom\ProcessingInstruction::ownerDocument のデモンストレーション ===\n";
36
37    // 6. 取得したオーナードキュメントが、元々ノードを作成したドキュメントと
38    // 同じインスタンスであるかを確認します。
39    if ($ownerDocument === $document) {
40        echo "✔ 処理命令の ownerDocument は、ノードを作成したドキュメントと同じインスタンスです。\n";
41        echo "   オーナードキュメントの XML バージョン: " . ($ownerDocument ? $ownerDocument->xmlVersion : 'N/A') . "\n";
42    } else {
43        echo "❌ エラー: ownerDocument が期待するドキュメントと一致しません。\n";
44    }
45
46    echo "\n=== 生成されたXMLのプレビュー ===\n";
47    echo $document->saveXML();
48}
49
50// 関数を実行します。
51demonstrateProcessingInstructionOwnerDocument();
52

Dom\ProcessingInstruction::ownerDocumentプロパティは、XMLドキュメント内の処理命令ノード（Dom\ProcessingInstructionオブジェクト）がどのDom\Documentオブジェクトに属しているかを取得するために使用されます。このプロパティは引数を取らず、その処理命令ノードが「オーナー」として所属するDom\Documentオブジェクトを返します。もしノードがまだどのドキュメントにも関連付けられていない場合は、nullを返す可能性があります。

このサンプルコードは、まず新しいDom\Documentオブジェクトを作成し、これをXMLドキュメントの基盤としています。次に、このドキュメント内に処理命令ノード（例：<?xml-stylesheet ...?>）を作成し、ドキュメントツリーに追加します。その後、作成した処理命令ノードに対してownerDocumentプロパティにアクセスすることで、そのノードが属しているDom\Documentオブジェクトを取得しています。最終的に、取得したオーナードキュメントが、ノードを作成した元のDom\Documentオブジェクトと完全に一致することを確認しており、これにより、任意のノードからその所属ドキュメントを特定する方法を示しています。

Dom\ProcessingInstruction::ownerDocumentプロパティは、その処理命令ノードがどのDom\Documentオブジェクトに属しているかを示します。このプロパティは、ノードがドキュメントの文脈で正しく操作されているかを確認する際に重要です。リファレンスの通り、このプロパティはnullを返す可能性があるため、ノードがまだどのドキュメントにも追加されていない場合などはnullが返されます。取得した値を利用する前にはnullチェックを行うと、予期せぬエラーを防ぎ、より安全にコードを扱えます。サンプルコードでは、作成したノードが意図したDom\Documentに正しく属していることを厳密な比較===で確認しており、これはオブジェクトの同一性を保証する良い方法です。このプロパティは、Dom\ProcessingInstructionだけでなく、他の多くのDOMノードでも同様に利用できます。