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

『compareDocumentPositionメソッドは、あるエンティティ参照ノードと、引数で指定した別のノードの、文書内における相対的な位置関係を比較するために実行するメソッドです。このメソッドは、引数として比較対象となるノードオブジェクトを受け取ります。実行されると、2つのノードの位置関係を示す整数値を返します。この戻り値はビットマスクと呼ばれる特殊な形式の数値で、複数の状態を同時に表現できます。例えば、引数のノードが現在のノードよりも後に出現する場合は XML_DOCUMENT_POSITION_FOLLOWING という定数値が含まれ、逆に前に出現する場合は XML_DOCUMENT_POSITION_PRECEDING が含まれます。また、引数のノードが現在のノードの子孫である場合は XML_DOCUMENT_POSITION_CONTAINED_BY、現在のノードが引数のノードを包含している場合は XML_DOCUMENT_POSITION_CONTAINS が関係を示します。これらの関係は組み合わせで返されることがあるため、特定の位置関係を判定するには、戻り値とこれらの定数をビット単位のAND演算子（&）を用いて比較する必要があります。これにより、DOMツリー上でのノードの複雑な前後関係や親子関係を正確に把握することが可能になります。』

Copy
1<?php
2
3$doc = new Dom\Document();
4$root = $doc->createElement('root');
5$doc->appendChild($root);
6
7$entityRef = $doc->createEntityReference('example');
8$root->appendChild($entityRef);
9
10$otherNode = $doc->createElement('p');
11$root->appendChild($otherNode);
12
13$position = $entityRef->compareDocumentPosition($otherNode);
14
15?>

Dom\Node $other

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

int

このメソッドは、2つのDOMエンティティ参照の相対的な位置を示す整数値を返します。返される値は、ビットマスクとして解釈され、一方の参照が他方の参照の前に位置するか、あるいは同一であるかといった情報を示します。