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

DOCUMENT_POSITION_PRECEDING定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

『DOCUMENT_POSITION_PRECEDING定数は…を表す定数です』

DOCUMENT_POSITION_PRECEDING定数は、2つのDOMノードの位置関係を比較した際に、一方のノードがもう一方のノードよりもドキュメント内で先行していることを表す定数です。この定数は、Dom\Node::compareDocumentPosition() メソッドの返り値として使用されるビットマスク値の一部です。compareDocumentPosition() メソッドは、あるノードから見て、引数で指定されたノードがドキュメントツリーのどの位置にあるかを判定します。例えば、$nodeA->compareDocumentPosition($nodeB) を実行した結果にこの DOCUMENT_POSITION_PRECEDING 定数のビットが含まれていた場合、それは $nodeB$nodeA よりもドキュメントのソースコード順で前に出現することを示します。返り値は複数の状態を示すために、他の DOCUMENT_POSITION_* 定数とのビット単位の論理和として返されることがあります。そのため、特定の前後関係を確認するには、& 演算子を用いて ($result & Dom\Node::DOCUMENT_POSITION_PRECEDING) のように評価する必要があります。この定数を利用することで、DOMツリー内のノード間の厳密な順序関係をプログラムで正確に把握することが可能になります。

構文(syntax)

1<?php
2
3echo Dom\Comment::DOCUMENT_POSITION_PRECEDING;

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

DOCUMENT_POSITION_PRECEDING は、ノードが別のノードより前に位置することを示す整数値です。

関連コンテンツ

関連プログラミング言語