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

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

作成日: 2025年09月11日更新日: 2025年11月12日

基本的な使い方

compareDocumentPositionメソッドは、現在のDOMCharacterDataノードと、引数で指定された別のノードとのドキュメント内での位置関係を比較し、その結果をビットマスクとして返すメソッドです。このメソッドは、DOMツリー構造において、あるノードが別のノードより前にあるか、後にあるか、あるいは親子関係（祖先や子孫）にあるかといった複雑な位置関係を正確に判定するために使用されます。戻り値は整数で、複数の状態を同時に表現するビットマスクとなっています。例えば、定数DOMNode::DOCUMENT_POSITION_FOLLOWINGは指定したノードが後方にあることを示し、DOMNode::DOCUMENT_POSITION_CONTAINED_BYは指定したノードが祖先であることを示します。これらの定義済み定数と戻り値をビット単位のAND演算子(&)で比較することで、特定の位置関係を満たしているかどうかを判定できます。この機能により、DOM操作において、ノード間の相対的な位置に基づいた精密な処理を実装することが可能になります。

構文(syntax)


1$document = new DOMDocument();
2$document->loadXML('<root>text<!--comment--></root>');
3
4$nodeA = $document->documentElement->firstChild;
5$nodeB = $document->documentElement->lastChild;
6
7$comparisonResult = $nodeA->compareDocumentPosition($nodeB);

引数(parameters)

DOMNode $other

DOMNode $other: 比較対象となる別のDOMNodeオブジェクト

戻り値(return)

int

このメソッドは、2つのDOMノード間の文書内での相対的な位置関係を示す整数を返します。返される整数は、ビットマスクとして解釈され、ノードの包含関係や兄弟順序などの情報を示します。