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

『DOCUMENT_POSITION_CONTAINS定数は、DOMドキュメント内における2つのノードの位置関係を示すビットマスク値の一つで、基準となるノードが比較対象のノードを包含している状態を表す定数です。この定数は、主にDom\Node::compareDocumentPosition()メソッドの戻り値として利用されます。このメソッドは、あるノードから見て、引数で指定された別のノードがドキュメントツリーの中でどのような位置にあるかを判定するために使われます。compareDocumentPosition()メソッドを呼び出した結果の戻り値に、このDOCUMENT_POSITION_CONTAINS定数のビットが含まれている場合、それはメソッドを呼び出したノードが、引数で渡されたノードを子孫として含んでいることを意味します。例えば、あるHTML要素がその子要素の位置関係を問い合わせた場合などがこれに該当します。戻り値は複数の状態を同時に表現できるビットマスクであるため、特定の位置関係を正確に判定するには、ビット単位のAND演算子(&)を用いて、メソッドの戻り値とこの定数との比較を行う必要があります。

Copy
1<?php
2
3var_dump(Dom\ProcessingInstruction::DOCUMENT_POSITION_CONTAINS);

引数なし

引数はありません

int

DOCUMENT_POSITION_CONTAINS は、Dom\ProcessingInstruction オブジェクトが他のノードを包含していることを示す整数値 1 を返します。