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

compareDocumentPositionメソッドは、ある処理命令ノードと、引数で指定された別のノードの、ドキュメント内における相対的な位置関係を比較し、その結果を数値で返すメソッドです。処理命令ノードとは、<?xml-stylesheet ... ?> のように、文書の処理方法をアプリケーションに指示するためのノードを指します。このメソッドは、文書を階層的なツリー構造として扱うDOM（Document Object Model）において、2つのノードがどちらが先に現れるか、一方が他方を子孫として含んでいるか、あるいは全く別の文書に属しているかといった関係を判定するために使用されます。戻り値は、複数の状態を同時に表現できるビットマスクと呼ばれる整数値です。この数値には、先行、後続、内包、被内包といった様々な位置情報がフラグとして格納されています。開発者は、この戻り値と Dom\Node::DOCUMENT_POSITION_FOLLOWING のような定義済み定数をビット単位の論理積演算子（&）で比較することで、2つのノード間の具体的な関係性を正確に判断し、プログラムのロジックに活用することができます。

Copy
1<?php
2
3$document = new DOMDocument();
4$document->loadXML('<root><?php echo "Hello"; ?></root>');
5
6/** @var Dom\ProcessingInstruction $pi */
7$pi = $document->firstChild->firstChild;
8$node = $document->firstChild;
9
10// Dom\ProcessingInstruction オブジェクトの位置を
11// 別の Dom\Node オブジェクトと比較する
12$position = $pi->compareDocumentPosition($node);

Dom\Node $other

• Dom\Node $other: 比較対象となる他のノードを指定します。

int

このメソッドは、2つのDOMノード（このオブジェクトと指定されたノード）のドキュメント内での位置関係を示す整数値を返します。返される値は、ビットマスクとして解釈され、ノード間の位置関係を表します。