【PHP8.x】Dom\ProcessingInstruction::DOCUMENT_POSITION_CONTAINED_BY定数の使い方
DOCUMENT_POSITION_CONTAINED_BY定数の使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
『DOCUMENT_POSITION_CONTAINED_BY定数は、DOMドキュメント内における2つのノードの相対的な位置関係を示すために使用される、あらかじめ定義された整数値を表す定数です。この定数は、主に Dom\Node::compareDocumentPosition() メソッドの返り値に含まれるビットマスク値の一つとして利用されます。このメソッドは、あるノードが別のノードに対してどのような位置にあるかを判定し、その結果を数値で返します。返された数値に DOCUMENT_POSITION_CONTAINED_BY のビットが含まれている場合、それはメソッドを呼び出したノードが、引数として渡されたノードに内包されている、つまり子孫ノードであることを意味します。例えば、$childNode->compareDocumentPosition($parentNode) を実行した際にこの定数が返されたなら、$childNode は $parentNode の直接的または間接的な子要素であると判断できます。この値は他の位置関係を示す定数と組み合わせて返されることがあるため、ビット演算を用いて特定の包含関係を判定する際に使用します。これにより、XMLやHTML文書の複雑な階層構造の中から、ノード間の親子関係や包含関係をプログラムで正確に把握することが可能になります。
構文(syntax)
1Dom\ProcessingInstruction::DOCUMENT_POSITION_CONTAINED_BY;
引数(parameters)
引数なし
引数はありません
戻り値(return)
int
DOCUMENT_POSITION_CONTAINED_BY は、このノードが別のノードに含まれていることを示す整数値 1 を返します。