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

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

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

基本的な使い方

compareDocumentPositionメソッドは、あるノードと引数で指定された別のノードの、ドキュメント内での位置関係を比較するために実行するメソッドです。このメソッドは、比較対象となるノードオブジェクトを引数として受け取り、2つのノードの位置関係を示す整数値を返します。この戻り値はビットマスクであり、複数の状態を同時に表現することが可能です。例えば、引数のノードが呼び出し元のノードよりも前に出現する場合は DOM_DOCUMENT_POSITION_PRECEDING が、後に出現する場合は DOM_DOCUMENT_POSITION_FOLLOWING が含まれます。また、引数のノードが呼び出し元のノードの子孫である場合は DOM_DOCUMENT_POSITION_CONTAINS が、逆に祖先である場合は DOM_DOCUMENT_POSITION_CONTAINED_BY が含まれます。返された値とこれらの定義済み定数をビット単位のAND演算子(&)で比較することで、具体的な位置関係を判定できます。この機能により、DOMツリー内における2つの要素の前後関係や親子関係を正確に把握することができ、複雑なDOM操作を行う際に非常に役立ちます。

構文(syntax)


1<?php
2
3$document = new Dom\Document();
4$document->loadXML('<root><nodeA></nodeA><nodeB></nodeB></root>');
5
6$nodeA = $document->getElementsByTagName('nodeA')->item(0);
7$nodeB = $document->getElementsByTagName('nodeB')->item(0);
8
9$position = $nodeA->compareDocumentPosition($nodeB);
10
11var_dump($position);
12
13?>

引数(parameters)

Dom\Node $other

Dom\Node $other: 比較対象のDOMノード

戻り値(return)

int

このメソッドは、2つのDOMノードの位置関係を示す整数値を返します。返される値は、ビットフラグとして扱われ、ノードが互いにどのような関係にあるか（例: 左側にある、右側にある、親である、子であるなど）を表します。