【PHP8.x】Dom\EntityReference::DOCUMENT_POSITION_FOLLOWING定数の使い方

『DOCUMENT_POSITION_FOLLOWING定数は、2つのノードの文書内における位置関係を比較した結果、対象ノードが基準ノードの後に続くことを表す定数です。この定数は、主に Dom\Node::compareDocumentPosition() メソッドの戻り値を評価するために利用されます。このメソッドは、あるノードが別のノードに対して、文書内でどのような位置にあるかを示す数値を返します。compareDocumentPosition() の結果に DOCUMENT_POSITION_FOLLOWING が含まれている場合、それは比較対象のノードが、基準となるノードよりも後に出現することを意味します。ここでの「後」とは、HTMLやXMLといった文書のソースコードを上から順に読んだ際の出現順序に基づいています。compareDocumentPosition() メソッドが返す値は、複数の状態を同時に表現できるビットマスクであるため、特定の状態を確認するには、ビット単位のAND演算子（&）を用いて判定します。例えば、$result & Dom\Node::DOCUMENT_POSITION_FOLLOWING のように記述することで、ノードが後続であるかどうかを確実に判定できます。この定数により、DOMツリー内のノード間の前後関係をプログラムで正確に把握し、順序に基づいた処理を実装することが可能になります。

Copy
1<?php
2
3$doc = new \DOMDocument();
4$doc->loadXML('<root><node1/><node2/></root>');
5
6$node1 = $doc->getElementsByTagName('node1')->item(0);
7$node2 = $doc->getElementsByTagName('node2')->item(0);
8
9// 2つのノードの位置関係を比較します。
10$position = $node1->compareDocumentPosition($node2);
11
12// $node2 が $node1 の後に続くノードか判定します。
13// この定数は、比較結果を評価するためのビットマスクとして使用されます。
14if ($position & \Dom\EntityReference::DOCUMENT_POSITION_FOLLOWING) {
15    // $node2 は $node1 の後にあります。
16}

引数なし

引数はありません

戻り値なし

戻り値はありません