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

『DOCUMENT_POSITION_CONTAINED_BY定数は…を表す定数です』

DOCUMENT_POSITION_CONTAINED_BY定数は、DOMツリー内における2つのノードの位置関係を示すビットマスク値の一つを表す定数です。この定数は、主に Dom\Node::compareDocumentPosition() メソッドの返り値として利用され、あるノードが別のノードに完全に含まれている状態を示します。具体的には、メソッドを呼び出した基準となるノードが、引数で指定された比較対象のノードに内包されている場合に、返される数値にこの定数のビットが含まれます。例えば、$nodeA->compareDocumentPosition($nodeB) という処理を実行した際、その結果に DOCUMENT_POSITION_CONTAINED_BY のビットが含まれていれば、それは $nodeA が $nodeB の子や孫といった子孫ノードであることを意味します。compareDocumentPosition() メソッドの返り値は、複数の状態を同時に示すことがあるため、この定数とビット単位のAND演算子（&）を用いて特定の包含関係を判定するのが一般的です。この定数を利用することで、文書構造内でのノード間の正確な階層関係をプログラムで判定できます。

Copy
1<?php
2
3echo Dom\DocumentType::DOCUMENT_POSITION_CONTAINED_BY;

引数なし

引数はありません

int

DOCUMENT_POSITION_CONTAINED_BY は、あるノードが別のノードの内側に完全に含まれていることを示す整数値 1 を返します。