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

compareDocumentPositionメソッドは、現在のDOMNotationノードと、引数で指定された他のノードとのドキュメント内での相対的な位置関係を比較する処理を実行するメソッドです。このメソッドは、すべてのDOMノードの基底クラスであるDOMNodeクラスから継承されています。引数には、比較対象となるDOMNodeオブジェクトを渡します。メソッドが返却するのは、2つのノードの位置関係を示すビットマスクと呼ばれる整数値です。このビットマスクには、対象ノードが現在のノードより文書内で後にあるか（DOMNode::DOCUMENT_POSITION_FOLLOWING）、前にあるか（DOMNode::DOCUMENT_POSITION_PRECEDING）、あるいは互いに関係ないツリーに属しているか（DOMNode::DOCUMENT_POSITION_DISCONNECTED）といった情報が符号化されています。開発者は、この戻り値と定義済みの定数をビット単位の論理積（&演算子）を用いて比較することで、ノード間の詳細な関係を判定できます。これにより、DOMツリーの構造をプログラムで正確に把握し、ノードの順序や親子関係に基づいた処理を実装する際に利用されます。

Copy
1<?php
2
3$xml = <<<XML
4<?xml version="1.0"?>
5<!DOCTYPE root [
6  <!NOTATION notation1 PUBLIC "some-public-id">
7]>
8<root></root>
9XML;
10
11$doc = new DOMDocument();
12$doc->loadXML($xml);
13
14// $notation は DOMNotation オブジェクトです
15$notation = $doc->doctype->notations->getNamedItem('notation1');
16
17// $otherNode は DOMNode オブジェクトです
18$otherNode = $doc->documentElement;
19
20// public function DOMNotation::compareDocumentPosition(DOMNode $other): int
21$position = $notation->compareDocumentPosition($otherNode);
22
23?>

DOMNode $other

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

int

このメソッドは、2つのDOMノード間の相対的な位置関係を示す整数値を返します。