DOMNode::compareDocumentPosition

2つのノードの位置を比較します。

説明

public int DOMNode::compareDocumentPosition(DOMNode $other)

このノードに対するもう一方のノードの位置を比較します。

パラメータ

other: このノードに対して、位置を比較すべきノード。

戻り値

DOMNode::DOCUMENT_POSITION_* 定数のビットマスク。

例

例1 DOMNode::compareDocumentPosition の例

<?php
$xml = <<<XML
<root>
    <child1/>
    <child2/>
</root>
XML;

$dom = new DOMDocument();
$dom->loadXML($xml);

$root = $dom->documentElement;
$child1 = $root->firstElementChild;
$child2 = $child1->nextElementSibling;

var_dump($root->compareDocumentPosition($child1));
var_dump($child2->compareDocumentPosition($child1));
?>

上の例の出力は以下となります。

int(20) // DOMNode::DOCUMENT_POSITION_CONTAINED_BY | DOMNode::DOCUMENT_POSITION_FOLLOWING 定数
int(2)  // DOMNode::DOCUMENT_POSITION_PRECEDING 定数