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

ownerDocumentプロパティは、DOMNotationクラスに属し、その表記法ノードが属するDOMDocumentオブジェクトを保持するプロパティです。DOMNotationクラスは、XMLドキュメントのDTD（Document Type Definition）内で宣言される「表記法（NOTATION）」を表すノードです。表記法は、XMLドキュメント内で外部エンティティ（例えば、特定の画像形式や動画形式のファイルなど）を参照する際に、そのデータの形式を指定するために利用されます。

このownerDocumentプロパティは、DOMツリー内のあらゆるノードが、具体的にどのXMLドキュメント（DOMDocumentオブジェクト）の一部であるかを示します。DOMNotationノードもXMLドキュメントを構成する重要な要素の一つであるため、このプロパティを通じて、自身が関連付けられているDOMDocumentオブジェクトへアクセスすることができます。これにより、特定の表記法ノードから、そのノードが属するドキュメント全体の情報を取得したり、ドキュメントレベルの操作を行ったりすることが可能になります。

例えば、あるDOMNotationノードがどのXMLドキュメントに由来するものかを確認したい場合や、その表記法ノードを起点としてドキュメント全体の構造を解析したり、他のノードとの関連性を調べたりする際に、このownerDocumentプロパティが非常に役立ちます。これは、DOMの階層構造を正確に理解し、複雑なXMLドキュメントをプログラムで効率的に操作する上で不可欠な機能です。

Copy
1<?php
2$dom = new DOMDocument();
3$dom->loadXML('<!DOCTYPE root [<!NOTATION gif SYSTEM "image/gif">]><root/>');
4
5$notation = $dom->notations->getNamedItem('gif');
6
7if ($notation instanceof DOMNotation) {
8    $owningDocument = $notation->ownerDocument;
9}
10?>

引数なし

引数はありません

DOMDocument|null

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