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

『DOCUMENT_POSITION_FOLLOWING定数は、2つのノードの位置関係を比較した結果、一方のノードがもう一方のノードよりも文書内で後に続くことを表す定数です』

この定数は、主にDom\Node::compareDocumentPosition()メソッドの返り値を解釈するために使用されます。compareDocumentPosition()メソッドは、2つのノードの文書ツリー内での相対的な位置関係を判定し、その結果をビットマスクと呼ばれる特殊な整数値で返します。ビットマスクは、複数の状態（例えば「後に続く」「内包している」など）を一つの数値で表現するための仕組みです。

compareDocumentPosition()メソッドの返り値に対して、このDOCUMENT_POSITION_FOLLOWING定数を用いてビット単位の論理積（&演算子）を計算します。もし計算結果が0でない場合、それは比較元のノードが比較先のノードよりも文書の記述順で後に出現することを意味します。この定数を利用することで、DOMツリーにおけるノードの正確な前後関係をプログラムで確実に判定することが可能になります。

Copy
1<?php
2
3// DOMドキュメントを準備
4$xml = '<?xml version="1.0"?><root><child1/><?pi-target pi-data?></root>';
5$doc = new \Dom\Document();
6$doc->loadXML($xml);
7
8// 比較する2つのノードを取得
9$node1 = $doc->getElementsByTagName('child1')[0];
10$node2 = $doc->getElementsByTagName('root')[0]->childNodes[1]; // <?pi-target ...?>
11
12// node1から見てnode2の位置を比較
13$position = $node1->compareDocumentPosition($node2);
14
15// 比較結果のビットマスクに DOCUMENT_POSITION_FOLLOWING が含まれているか確認
16if ($position & \Dom\ProcessingInstruction::DOCUMENT_POSITION_FOLLOWING) {
17    // このブロックが実行される
18    echo "The processing instruction node follows the child1 element node.";
19}
20
21?>

引数なし

引数はありません

int

DOCUMENT_POSITION_FOLLOWING は、ノードが指定されたノードの後に位置することを示す整数値です。