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

getRootNodeメソッドは、ドキュメントオブジェクトモデル（DOM）ツリーにおける特定のノードが属する最上位の要素を取得するメソッドです。このメソッドは、PHPのDOM拡張機能において、Dom\Textクラスのインスタンス、つまりHTMLやXMLドキュメント内のテキストコンテンツを表すノードに対して利用されます。

getRootNodeメソッドを呼び出すと、そのテキストノードが所属しているドキュメントのルートノードを返します。一般的なWebページやXMLドキュメントの場合、これは通常Dom\Documentオブジェクトとなります。このDom\Documentオブジェクトは、ドキュメント全体の構造の頂点にあたるため、「根（ルート）」と呼ばれます。このメソッドには引数はありません。

この機能は、特定のテキストノードから始めて、それがどのドキュメントに属しているのか、そのドキュメント全体の構造はどうなっているのかを把握したい場合に非常に役立ちます。例えば、処理中のテキストノードから元のドキュメント全体にアクセスし、別の要素を検索したり、ドキュメント全体に対して何らかの変更を加えたりする際に利用できます。DOMツリー構造を理解し、複雑なドキュメント操作を行う上で、このgetRootNodeメソッドは基点となる重要な役割を果たします。

Copy
1<?php
2
3$dom = new Dom\Document();
4$element = $dom->createElement('example', 'テキスト内容');
5$dom->appendChild($element);
6
7// テキストノードを取得
8$textNode = $element->firstChild;
9
10// Dom\Text::getRootNode() メソッドを呼び出す
11$rootNode = $textNode->getRootNode();
12
13?>

?array $options = null

• ?array $options = null: DOMNodesを処理する際のオプションを指定する配列。指定しない場合はデフォルトのオプションが使用される。

Dom\Node|null

このメソッドは、現在のTextノードの祖先ノードであるDom\Nodeオブジェクト、または存在しない場合はnullを返します。