【PHP8.x】getRootNodeメソッドの使い方

getRootNodeメソッドは、Dom\DocumentFragmentクラスに属するオブジェクトに対して、それが属するノードツリーの最上位にあるルートノードを取得するために実行するメソッドです。

Dom\DocumentFragmentは、XMLやHTMLなどのDOMツリーにおいて、複数のノードを一時的にまとめるための特殊なノードです。これは、実際のドキュメントに挿入されるまでは独立した部分的な文書として扱われ、効率的なDOM操作に利用されます。

このgetRootNodeメソッドは、通常、呼び出されたノードが属する文書ツリーの最も上位にあるノード、つまりルートノードを返します。しかし、Dom\DocumentFragmentオブジェクトに対してgetRootNodeメソッドが呼び出された場合、その挙動は少し異なります。Dom\DocumentFragmentはそれ自体が独立した部分的な文書のルートとして機能するため、このメソッドはそのDom\DocumentFragmentオブジェクト自体を返します。

これにより、Dom\DocumentFragment内部のノードが、どの独立したまとまりに属しているか、あるいはそのまとまりの起点がどこであるかを確認することができます。例えば、複数のノードを一度に生成し、それを最終的に実際のドキュメントに挿入する前に、そのノード群が一時的にどのコンテキストに属しているかを把握する際に利用できます。このメソッドは、DOM操作においてノードの所属関係を正確に理解する上で重要な役割を果たします。

Copy
1<?php
2
3$document = new Dom\Document();
4$fragment = $document->createDocumentFragment();
5$fragment->appendHTML('<h1>タイトル</h1><p>テキスト</p>');
6
7$rootNode = $fragment->getRootNode();
8
9?>

引数なし

引数はありません

Dom\Node

このメソッドは、DOMツリーにおける現在のノードの最も近い祖先ノード、または現在のノード自体を返します。