【PHP8.x】Dom\ProcessingInstruction::getRootNode()メソッドの使い方

getRootNodeメソッドは、その処理命令ノードが属するDOMツリーのルートノードを取得するメソッドです。XMLやHTML文書は、DOMにおいて要素やテキストなどのノードが階層的に連なったツリー構造として扱われます。このツリー構造の最上位にあるノードがルートノードであり、通常は文書全体を表す Dom\Document オブジェクトです。このメソッドを Dom\ProcessingInstruction オブジェクトに対して呼び出すと、そのノードが現在含まれている文書ツリーの頂点、すなわち Dom\Document オブジェクトを返します。これにより、特定の処理命令から文書全体の情報にアクセスしたり、他のノードを操作したりする際の起点を得ることができます。もし、対象のノードがまだどのドキュメントにも追加されておらず、ツリーに属していない独立した状態の場合、このメソッドはそのノード自身を返します。これは、そのノードが自身をルートとする単一ノードのツリーと見なされるためです。引数にオプションを指定することも可能ですが、基本的な使用法では引数なしで呼び出します。

Copy
1<?php
2
3// DOMツリーのルートとなるDocumentオブジェクトを作成します
4$document = new \Dom\Document();
5
6// Documentに属するProcessingInstructionノードを作成します
7$pi = $document->createProcessingInstruction('php', 'echo "Hello World";');
8$document->appendChild($pi);
9
10// ProcessingInstructionノードから、それが属するツリーのルートノードを取得します
11$rootNode = $pi->getRootNode();
12
13// 取得したルートノードのクラス名を確認します (この場合は "Dom\Document")
14echo $rootNode::class;
15
16?>

array $options = []

• array $options = []: 処理のオプションを指定する連想配列。デフォルトは空の配列。

Dom\Node

このメソッドは、処理命令ノードのルートノードを表すDom\Nodeオブジェクトを返します。