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

getRootNodeメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

getRootNodeメソッドは、DOMDocumentFragmentオブジェクトが属する最も上位のルートノードを取得するメソッドです。DOMDocumentFragmentは、実際のウェブページなどの文書ツリーに挿入される前に、複数のノード(要素やテキストなど)を一時的に保持するための軽量なコンテナとして機能します。このメソッドは、呼び出されたノードのコンテキストにおける根(ルート)となるノード、すなわちDocument、DocumentFragment、またはShadowRootのいずれかのオブジェクトを返します。

DOMDocumentFragmentクラスのインスタンスに対してgetRootNodeメソッドを呼び出した場合、通常はそのDOMDocumentFragmentオブジェクト自身をルートノードとして返します。これは、DOMDocumentFragmentがそれ自体で独立したノードの断片を形成し、自身の内部に独自のサブツリーを持つことが多いためです。このメソッドは、特定のノードがどのコンテキストの頂点に位置しているかを確認したい場合に有用です。例えば、ノードがまだ文書全体のDOMDocumentオブジェクトに属していないDOMDocumentFragment内にあるのか、それともすでに実際の文書に組み込まれているのかを判断する際に利用できます。戻り値はDOMNode型のオブジェクトであり、具体的なルートノードを表します。

構文(syntax)

1<?php
2
3$fragment = new DOMDocumentFragment();
4$rootNode = $fragment->getRootNode();
5
6?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

DOMNode|null

このメソッドは、DOMDocumentFragment オブジェクトのルートノードを表す DOMNode オブジェクト、あるいはドキュメントフラグメントが空の場合は null を返します。

【PHP8.x】getRootNodeメソッドの使い方 | いっしー@Webエンジニア