【PHP8.x】DOMEntityReference::DOCUMENT_POSITION_FOLLOWING定数の使い方
DOCUMENT_POSITION_FOLLOWING定数の使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
『DOCUMENT_POSITION_FOLLOWING定数は、2つのDOMノードの位置関係を比較した結果、対象ノードが基準ノードよりも文書内で後に続くことを表す定数です』
この定数は、主にDOMNode::compareDocumentPosition()メソッドの戻り値として使用されるビットマスク値の一つです。DOM(Document Object Model)は、HTMLやXML文書をプログラムが操作できるツリー構造として表現する仕組みであり、文書内の各要素やテキストは「ノード」というオブジェクトとして扱われます。compareDocumentPosition()メソッドは、あるノードが別のノードに対して、文書の読み取り順でどのような位置にあるか(前か、後か、内包しているかなど)を判定するために利用されます。このメソッドを呼び出した際、比較対象のノードが基準となるノードの後に位置している場合に、戻り値にDOCUMENT_POSITION_FOLLOWINGのフラグが含まれます。戻り値は複数の状態を同時に示す場合があるため、この定数と完全一致(==)で比較するのではなく、ビット単位のAND演算子(&)を用いてフラグの有無を確認することが推奨されます。これにより、ノード間の正確な順序関係をプログラムで確実に判断できます。
構文(syntax)
1<?php 2 3echo DOMEntityReference::DOCUMENT_POSITION_FOLLOWING;
引数(parameters)
引数なし
引数はありません
戻り値(return)
int
DOMEntityReference::DOCUMENT_POSITION_FOLLOWING は、ノードが指定されたノードの後に続くことを示す整数値 1 を返します。