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

getRootNodeメソッドは、DOMTextクラスに属し、現在のノードが属するDOMツリーのルートノードを取得するメソッドです。PHPのDOM拡張機能は、HTMLやXML文書をプログラムで操作するための標準的な方法を提供します。これらの文書は、ノードと呼ばれる要素が階層的に配置されたツリー構造で表現され、例えば、ウェブページの各要素やテキストなどがノードに該当します。DOMツリーにおいて、ルートノードはそのツリーの最上位に位置するノードであり、ツリー全体を表します。これは通常、HTML文書全体を管理するDocumentオブジェクトか、ウェブコンポーネントなどで利用されるShadowRootオブジェクトのいずれかになります。getRootNodeメソッドを呼び出すことで、現在操作しているDOMTextノードがどのDOMツリーに属しているのか、そしてそのツリーの最上位のノードは何であるかを簡単に知ることができます。この機能は、現在のノードが標準のドキュメントに属しているのか、それとも隔離されたShadow DOMツリーに属しているのかを判別し、その後の処理を分岐させるといった用途に活用できます。特に、ウェブコンポーネントのように複数のDOMツリーが共存する複雑なアプリケーションを開発する際に役立ちます。このメソッドは引数を必要とせず、常にDocumentオブジェクトまたはShadowRootオブジェクトを返します。

Copy
1<?php
2$dom = new DOMDocument();
3$element = $dom->createElement('example');
4$textNode = $dom->createTextNode('Hello World!');
5$element->appendChild($textNode);
6$dom->appendChild($element);
7
8$rootNode = $textNode->getRootNode();
9?>

int $options = 0

• int $options = 0: ルートノードを検索する際に適用されるオプションを指定する整数。デフォルトは0。

DOMNode

このメソッドは、現在のDOMTextノードが属するツリーのルートノードであるDOMNodeオブジェクトを返します。