【PHP8.x】DOMEntityReference::DOCUMENT_POSITION_DISCONNECTED定数の使い方
DOCUMENT_POSITION_DISCONNECTED定数の使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
DOCUMENT_POSITION_DISCONNECTED定数は、2つのDOMノードが同じドキュメントツリーに属していない、つまり互いに接続されていない状態を表す定数です。この定数は、主にDOMNode::compareDocumentPosition()メソッドの戻り値として利用されます。compareDocumentPosition()メソッドは、あるノードを基準にして、引数で渡された別のノードがドキュメント内でどのような位置関係にあるかを判定するためのものです。メソッドの実行結果は、ノード間の関係を示す複数の定数を組み合わせたビットマスクとして返されます。その返された値にDOCUMENT_POSITION_DISCONNECTEDが含まれている場合、それは比較した2つのノードが異なるドキュメントに属しているか、あるいはどちらか一方がまだドキュメントツリーに追加されていない孤立した状態であることを示します。例えば、createElementでノードを生成した直後や、ドキュメントからremoveChildで切り離されたノードを比較した場合に、この定数を含む値が返ります。この定数を用いてビット単位の論理積演算を行うことで、ノードが意図したドキュメントに正しく配置されているかを確認できます。
構文(syntax)
1DOMEntityReference::DOCUMENT_POSITION_DISCONNECTED;
引数(parameters)
引数なし
引数はありません
戻り値(return)
int
DOMDocument::load() や DOMDocument::save() などのメソッドで、ノードが別のドキュメントに属しているか、またはどのドキュメントにも属していない状態を表す整数値です。