【PHP8.x】DOMProcessingInstruction::DOCUMENT_POSITION_CONTAINED_BY定数の使い方
DOCUMENT_POSITION_CONTAINED_BY定数の使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
『DOCUMENT_POSITION_CONTAINED_BY定数は、DOMドキュメント内における2つのノードの位置関係を示すビットマスク値の一つを表す定数です。この定数は、主にDOMNode::compareDocumentPosition()メソッドの戻り値を評価する際に使用されます。このメソッドは、あるノードが比較対象のノードに対して、ドキュメント内でどのような位置にあるかを判定します。compareDocumentPosition()メソッドの呼び出し元ノードが、引数で渡されたノードによって内包されている場合、つまり呼び出し元ノードが引数のノードの子孫である場合に、戻り値のビットマスクにこの定数のビットが含まれます。例えば、p要素ノードがdiv要素ノードの子要素である場合、p要素ノードのcompareDocumentPosition()メソッドにdiv要素ノードを渡して比較すると、結果にDOCUMENT_POSITION_CONTAINED_BYが含まれます。戻り値は他の状態を示す定数と組み合わされる可能性があるため、特定の状態を確認するには、戻り値とこの定数との間でビット単位のAND演算子（&）を用いて判定するのが一般的です。
構文(syntax)
1<?php 2 3echo DOMProcessingInstruction::DOCUMENT_POSITION_CONTAINED_BY;
引数(parameters)
引数なし
引数はありません
戻り値(return)
int
DOMDocument::loadHTML() などで作成されたDOMProcessingInstructionノードが、他のノードに含まれている状態を表す整数値です。