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

compareDocumentPositionメソッドは、DOMドキュメント内における現在のコメントノードと、引数で指定した別のノードとの位置関係を比較するメソッドです。このメソッドはDOMNodeクラスから継承されており、コメントだけでなく要素やテキストなど、すべてのノードタイプで利用可能です。DOMはドキュメントを階層的なツリー構造として扱いますが、このメソッドはそのツリー内での2つのノードのソースコード順での前後関係や、親子関係のような包含関係を判定します。メソッドの戻り値は、2つのノードの関係を示す整数値（ビットマスク）です。例えば、引数のノードが現在のノードより後に出現する場合はDOMNode::DOCUMENT_POSITION_FOLLOWINGが、引数のノードが現在のノードに含まれている場合はDOMNode::DOCUMENT_POSITION_CONTAINSが、それぞれ戻り値のビットマスクに含まれます。戻り値は複数の状態を同時に表現できるため、ビット単位のAND演算子(&)を用いて特定の位置関係にあるかを確認するのが一般的です。これにより、ドキュメントの構造を動的に解析し、複雑な条件に応じた処理を正確に行うことができます。

Copy
1<?php
2
3$doc = new DOMDocument();
4$doc->loadXML('<root><!--comment A--><p/><!--comment B--></root>');
5
6// 比較する2つのDOMCommentノードを取得します
7$commentA = $doc->documentElement->firstChild;
8$commentB = $doc->documentElement->lastChild;
9
10// $commentA から見た $commentB のドキュメント内での位置を比較します
11$position = $commentA->compareDocumentPosition($commentB);
12
13// 結果は位置関係を示す整数値 (ビットマスク) になります
14var_dump($position);
15
16?>

DOMNode $other

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

int

このメソッドは、他のDOMノードとの相対的な位置関係を示す整数値を返します。具体的には、比較対象のノードが現在のノードの前に位置するか、後に位置するか、あるいは同一であるかなどの情報がビットマスクとして返されます。