【PHP8.x】DOMProcessingInstruction::DOCUMENT_POSITION_PRECEDING定数の使い方

DOCUMENT_POSITION_PRECEDING定数は、あるノードが比較対象のノードよりも文書内で前に出現することを示す定数です。この定数はDOMNodeクラスから継承されており、主にDOMNode::compareDocumentPosition()メソッドの戻り値として利用されます。このメソッドは、文書内における2つのノードの相対的な位置関係を判定し、その結果をビットマスク形式の整数値で返します。例えば、あるノード$nodeAから$nodeA->compareDocumentPosition($nodeB)を実行した際に、戻り値にDOCUMENT_POSITION_PRECEDING定数のビットが含まれていた場合、それは引数で指定した$nodeBが、基準となる$nodeAよりも文書構造上で先行している、つまりソースコード上でより先に現れることを意味します。戻り値は複数の状態を同時に表現するビットマスクであるため、特定の位置関係を判定するには、ビット単位の論理積（&）演算子を用いて評価するのが一般的です。この定数を利用することで、DOMツリー内のノードの順序を正確に把握し、ノードの並び替えや探索といった処理を確実に行うことができます。

Copy
1<?php
2
3$dom = new DOMDocument();
4$dom->loadXML('<?xml version="1.0"?><root><?pi one?><child/><?pi two?></root>');
5
6$pi1 = $dom->getElementsByTagName('one')->item(0);
7$pi2 = $dom->getElementsByTagName('two')->item(0);
8
9// $pi2 から見て $pi1 の位置を比較します。
10$comparison = $pi2->compareDocumentPosition($pi1);
11
12// $pi1 は $pi2 より前に出現するため、結果には DOCUMENT_POSITION_PRECEDING フラグが含まれます。
13if ($comparison & DOMProcessingInstruction::DOCUMENT_POSITION_PRECEDING) {
14    // この定数はビットマスク値のため、ビット単位のAND(&)演算子でチェックします。
15    echo "最初の処理命令は2番目の処理命令より先行しています。";
16}
17
18?>

引数なし

引数はありません

int

DOMProcessingInstruction::DOCUMENT_POSITION_PRECEDINGは、ノードが指定したノードの前に位置することを示す整数値を返します。