【PHP8.x】Dom\XMLDocument::ownerDocumentプロパティの使い方
ownerDocumentプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
『ownerDocumentプロパティは、あるノードが属しているドキュメント全体を表すDom\XMLDocumentオブジェクトを保持するプロパティです。Dom\XMLDocumentクラス自身もノードの一種ですが、このクラスのインスタンスでownerDocumentプロパティにアクセスした場合、その値は常にnullとなります。これは、Dom\XMLDocumentオブジェクトがXMLドキュメント構造における最上位のルート(根)にあたるためです。他の要素ノードやテキストノードといったすべての子ノードは、このドキュメントに所属していますが、ドキュメント自身がさらに上位のドキュメントに所属することはありません。したがって、「所有者であるドキュメント」が存在しないことを示すnullが返される仕様となっています。例えば、createElementメソッドで作成した要素ノードからこのプロパティを参照すると、その要素が属しているDom\XMLDocumentオブジェクトを取得できますが、ドキュメントオブジェクト自身からは取得できない点に注意が必要です。このプロパティは読み取り専用であり、値を変更することはできません。
構文(syntax)
1<?php 2 3$document = new Dom\XMLDocument(); 4 5// Dom\XMLDocument インスタンスの ownerDocument プロパティを取得します。 6// このプロパティの値は常に null です。 7$owner = $document->ownerDocument; 8 9var_dump($owner); 10 11?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
?Dom\XMLDocument
このプロパティは、XML文書のルート要素(所有者)である Dom\XMLDocument オブジェクトを返します。ただし、要素が DOMDocument に直接追加されている場合は null を返します。
サンプルコード
ownerDocumentでHTMLを保存する
1<?php 2 3/** 4 * PHP 8 Dom\XMLDocument の ownerDocument プロパティ(リファレンス情報に基づく) 5 * および saveHTML メソッドの使用例を示します。 6 * 7 * 注記: 提供されたリファレンス情報では Dom\XMLDocument に ownerDocument プロパティがあるとされていますが、 8 * 実際のPHP標準の Dom\XMLDocument クラスにはこのプロパティは直接存在しません。 9 * 一般的に ownerDocument は Dom\Node インターフェースを実装するクラス(例: Dom\Element)のプロパティです。 10 * 本サンプルコードは、提示されたリファレンス情報に厳密に従って記述されています。 11 */ 12function demonstrateOwnerDocumentAndSaveHtml(): void 13{ 14 // 新しい Dom\XMLDocument インスタンスを作成 15 $document = new Dom\XMLDocument(); 16 17 // HTML コンテンツをドキュメントにロード 18 // Dom\XMLDocument は XML ドキュメントを扱うためのクラスですが、loadHTML を使用してHTMLをパースすることも可能です。 19 $document->loadHTML('<!DOCTYPE html><html><head><title>Sample Document</title></head><body><h1>Hello World!</h1><p>This is a paragraph.</p></body></html>'); 20 21 // リファレンス情報に基づき、Dom\XMLDocument の ownerDocument プロパティにアクセス 22 // 戻り値は ?Dom\XMLDocument なので、null の可能性も考慮します。 23 $ownerDocument = $document->ownerDocument; 24 25 // ownerDocument が Dom\XMLDocument インスタンスであることを確認 26 if ($ownerDocument instanceof Dom\XMLDocument) { 27 echo "--- ownerDocument から取得したHTML ---\n"; 28 // ownerDocument の内容を HTML 文字列として保存し、出力します。 29 echo $ownerDocument->saveHTML(); 30 } else { 31 echo "--- ownerDocument が見つからなかった、または null のため、元のドキュメントのHTMLを保存 ---\n"; 32 // ownerDocument が null または想定外の型だった場合、元のドキュメントを保存して出力します。 33 echo $document->saveHTML(); 34 } 35} 36 37// 関数を実行して、サンプルコードの動作を確認します。 38demonstrateOwnerDocumentAndSaveHtml(); 39
このPHPコードは、Dom\XMLDocumentクラスのownerDocumentプロパティとsaveHTMLメソッドの使用例を示しています。まず、Dom\XMLDocumentの新しいインスタンスを作成し、loadHTMLメソッドを用いてHTMLコンテンツを読み込み、ドキュメントオブジェクトとしてメモリ上に構築します。
次に、リファレンス情報に基づき、この$documentオブジェクトからownerDocumentプロパティにアクセスします。ownerDocumentプロパティは、通常、特定のノードが属しているルートのドキュメントオブジェクト(Dom\XMLDocumentやDom\Documentなど)を返します。このプロパティの戻り値は?Dom\XMLDocumentと定義されているため、nullになる可能性も考慮されています。ただし、実際のPHP標準のDom\XMLDocumentクラスには、このプロパティは直接存在しない点にご留意ください。このサンプルは、提供されたリファレンス情報に厳密に従って記述されています。
最後に、saveHTMLメソッドを使用して、ドキュメントのHTML表現を文字列として取得し、出力しています。saveHTMLは引数なしで呼び出すことで、対象となるドキュメントやノード全体のHTMLコンテンツを返します。コードでは、ownerDocumentが有効なDom\XMLDocumentインスタンスであればその内容を、そうでなければ元のドキュメントの内容を出力し、これらのプロパティやメソッドの動作を確認しています。
このサンプルコードは、提供されたリファレンス情報に基づいていますが、実際のPHP標準のDom\XMLDocumentクラスにはownerDocumentプロパティは直接存在しない点に注意が必要です。通常、ownerDocumentはDom\Elementなどの個々のノードが、自身が属するドキュメントオブジェクト(Dom\XMLDocumentやDom\HTMLDocument)を参照するために使用するプロパティです。そのため、Dom\XMLDocumentインスタンスでこのプロパティにアクセスすると、ほとんどの場合nullが返されます。
コードを安全に利用するためには、戻り値が?Dom\XMLDocumentであることから、常にif ($ownerDocument instanceof Dom\XMLDocument)のようにnullであるかどうかのチェックを必ず行ってください。saveHTMLメソッドは、Dom\XMLDocumentオブジェクトが現在保持しているHTMLコンテンツを文字列として取得する際に使用します。
PHP Dom\XMLDocument ownerDocument 取得
1<?php 2 3// Dom\XMLDocument の ownerDocument プロパティの動作を示す関数 4function demonstrateDomXmlDocumentOwner(): void 5{ 6 // 新しい Dom\XMLDocument オブジェクトを作成し、XMLコンテンツをロードします。 7 // これは、XMLツリーのルートとなるドキュメントノードそのものです。 8 $document = new Dom\XMLDocument(); 9 $document->loadXML('<settings><theme>dark</theme><language>en</language></settings>'); 10 11 echo "Dom\\XMLDocument の ownerDocument プロパティの動作確認。\n\n"; 12 13 // Dom\XMLDocument は Dom\Node を継承しており、ownerDocument プロパティを持ちます。 14 // 通常、ドキュメントノード自身の ownerDocument は、そのドキュメント自身を指します。 15 $ownerDocument = $document->ownerDocument; 16 17 // ownerDocument プロパティの戻り値が ?Dom\XMLDocument なので、null の可能性も考慮します。 18 if ($ownerDocument === null) { 19 echo "結果: Dom\\XMLDocument の ownerDocument は null を返しました。\n"; 20 echo "(通常、XMLコンテンツがロードされたドキュメントでは発生しません。)\n"; 21 } elseif ($ownerDocument === $document) { 22 echo "結果: Dom\\XMLDocument の ownerDocument は、元のドキュメントと同じオブジェクトです。\n"; 23 echo "これは、XML ドキュメントが自身の所有者ドキュメントであることを示します。\n"; 24 } else { 25 echo "結果: Dom\\XMLDocument の ownerDocument は、元のドキュメントとは異なるオブジェクトです。\n"; 26 // このケースは、Dom\XMLDocument の通常の動作では発生しないはずです。 27 } 28} 29 30// 関数を実行して動作を確認します。 31demonstrateDomXmlDocumentOwner();
PHP 8のDom\XMLDocumentクラスが持つownerDocumentプロパティは、そのノードが属しているドキュメントノードを指すプロパティです。このプロパティは引数を一切取らず、戻り値は?Dom\XMLDocument型となります。これは、Dom\XMLDocumentオブジェクトが返されるか、あるいはノードがまだどのドキュメントにも関連付けられていない場合にnullが返される可能性があることを意味します。
特にDom\XMLDocumentオブジェクト自身の場合、これはXMLドキュメント全体のルートノードであるため、自身のownerDocumentプロパティにアクセスすると、そのDom\XMLDocumentオブジェクト自身を返します。これは、XMLドキュメント自身が、そのドキュメントの「所有者」であることを明確に示しています。
サンプルコードでは、まずXMLコンテンツをロードしたDom\XMLDocumentオブジェクトを作成します。次に、このドキュメントオブジェクトからownerDocumentプロパティを取得し、それが元のドキュメントオブジェクトと全く同じものであることを確認しています。コードの実行結果は「Dom\XMLDocument の ownerDocument は、元のドキュメントと同じオブジェクトです」と表示され、この挙動が期待通りであることを示します。このプロパティは、XMLツリー内の要素や属性などのノードが、どの親ドキュメントに属しているかを特定する際に活用されます。
PHPのDom\XMLDocumentクラスにおいて、ownerDocumentプロパティは通常、そのドキュメントオブジェクト自身を返します。これは、XMLドキュメントが自身の所有者であるということを示します。このプロパティは、XMLツリー内の他の要素やテキストノードなどで、そのノードがどのドキュメントに属しているかを確認する際に重要な役割を果たします。戻り値の型が?Dom\XMLDocumentと定義されているため、常にnullを返す可能性を考慮し、処理の前に必ずnullチェックを行うようにしてください。特に、まだドキュメントに所属していないノードからアクセスする場合にnullが返されることがありますので注意が必要です。