【PHP8.x】DOCUMENT_POSITION_CONTAINS定数の使い方

『DOCUMENT_POSITION_CONTAINS定数は、2つのDOMノード間の位置関係を判定する際に、一方のノードがもう一方のノードを含んでいる状態を表す定数です。この定数は主に、DOMNode::compareDocumentPosition() メソッドの返り値に含まれるビットマスク値として使用されます。このメソッドは、2つのノードの相対的な位置関係を、複数の状態を表すフラグが組み合わさった一つの数値で返します。返された数値に DOCUMENT_POSITION_CONTAINS 定数が示すビットが含まれているかを確認することで、ノードの包含関係を判定できます。具体的には、$nodeA->compareDocumentPosition($nodeB) を実行した結果とこの定数をビット単位の論理積（&）で評価します。結果が0でなければ、$nodeA が $nodeB を子孫ノードとして含んでいる（$nodeB は $nodeA の中にある）ことを意味します。この仕組みにより、DOMツリー内における要素の親子や祖先関係を正確に把握し、複雑なドキュメント構造をプログラムから効率的に操作することが可能になります。』

Copy
1<?php
2
3$doc = new DOMDocument();
4$doc->loadXML('<root><child/></root>');
5
6$rootNode = $doc->documentElement;
7$childNode = $rootNode->firstChild;
8
9// $rootNode が $childNode を含んでいるかを判定します。
10// compareDocumentPosition() の返り値とビット論理積(&)で評価します。
11$result = $rootNode->compareDocumentPosition($childNode);
12
13if ($result & Dom\DocumentType::DOCUMENT_POSITION_CONTAINS) {
14    // この条件式は true となります。
15}
16

引数なし

引数はありません

int

Dom\DocumentType::DOCUMENT_POSITION_CONTAINS は、あるノードが別のノードを完全に含んでいることを示す整数定数です。