【PHP8.x】DOMNode::DOCUMENT_POSITION_FOLLOWING定数の使い方

Copy
1<?php
2
3/**
4 * DOMNode::compareDocumentPosition メソッドと関連定数を使用して、
5 * 2つのDOMノード間の文書位置を比較するサンプルです。
6 *
7 * DOMNode::DOCUMENT_POSITION_FOLLOWING は、比較対象のノードが参照ノードに続いて出現することを示します。
8 * DOMNode::DOCUMENT_POSITION_PRECEDING は、比較対象のノードが参照ノードに先行して出現することを示します。
9 */
10function demonstrateDomNodePositionComparison(): void
11{
12    // 新しいDOMDocumentオブジェクトを作成
13    $dom = new DOMDocument();
14
15    // HTMLコンテンツをロード。`libxml_use_internal_errors(true)`でHTMLの構文エラーを抑制することも可能。
16    $html = '
17    <div id="container">
18        <p id="first-item">最初の要素</p>
19        <span id="middle-item">真ん中の要素</span>
20        <p id="last-item">最後の要素</p>
21    </div>';
22    $dom->loadHTML($html);
23
24    // 比較対象となるDOMノードを取得
25    $firstItem = $dom->getElementById('first-item');
26    $middleItem = $dom->getElementById('middle-item');
27    $lastItem = $dom->getElementById('last-item');
28
29    // ノードが正しく取得できたか確認
30    if (!$firstItem || !$middleItem || !$lastItem) {
31        echo "エラー: 必要なDOM要素が見つかりませんでした。\n";
32        return;
33    }
34
35    echo "--- DOMノード間の位置関係の比較 ---\n\n";
36
37    // ケース1: middleItemからfirstItemを比較
38    // firstItemはmiddleItemの前に位置する
39    $positionResult1 = $middleItem->compareDocumentPosition($firstItem);
40    echo "比較: middleItem (id='{$middleItem->id}') と firstItem (id='{$firstItem->id}')\n";
41    if ($positionResult1 & DOMNode::DOCUMENT_POSITION_PRECEDING) {
42        echo "  -> firstItem は middleItem に先行しています (DOCUMENT_POSITION_PRECEDING).\n";
43    }
44    if ($positionResult1 & DOMNode::DOCUMENT_POSITION_FOLLOWING) {
45        // この場合は通常真にはならない
46        echo "  -> firstItem は middleItem に続いています (DOCUMENT_POSITION_FOLLOWING).\n";
47    }
48    echo "\n";
49
50    // ケース2: firstItemからmiddleItemを比較
51    // middleItemはfirstItemの後に位置する
52    $positionResult2 = $firstItem->compareDocumentPosition($middleItem);
53    echo "比較: firstItem (id='{$firstItem->id}') と middleItem (id='{$middleItem->id}')\n";
54    if ($positionResult2 & DOMNode::DOCUMENT_POSITION_PRECEDING) {
55        // この場合は通常真にはならない
56        echo "  -> middleItem は firstItem に先行しています (DOCUMENT_POSITION_PRECEDING).\n";
57    }
58    if ($positionResult2 & DOMNode::DOCUMENT_POSITION_FOLLOWING) {
59        echo "  -> middleItem は firstItem に続いています (DOCUMENT_POSITION_FOLLOWING).\n";
60    }
61    echo "\n";
62
63    // ケース3: middleItemからlastItemを比較
64    // lastItemはmiddleItemの後に位置する
65    $positionResult3 = $middleItem->compareDocumentPosition($lastItem);
66    echo "比較: middleItem (id='{$middleItem->id}') と lastItem (id='{$lastItem->id}')\n";
67    if ($positionResult3 & DOMNode::DOCUMENT_POSITION_PRECEDING) {
68        // この場合は通常真にはならない
69        echo "  -> lastItem は middleItem に先行しています (DOCUMENT_POSITION_PRECEDING).\n";
70    }
71    if ($positionResult3 & DOMNode::DOCUMENT_POSITION_FOLLOWING) {
72        echo "  -> lastItem は middleItem に続いています (DOCUMENT_POSITION_FOLLOWING).\n";
73    }
74    echo "\n";
75}
76
77// 関数を実行して結果を表示
78demonstrateDomNodePositionComparison();
79
80?>

このPHPサンプルコードは、HTMLドキュメント内のDOMノード（要素）同士が、文書内でどのような位置関係にあるかを比較する方法を説明しています。具体的には、DOMNodeクラスのcompareDocumentPositionメソッドと、その結果を解釈するための関連定数を使用します。

DOMNode::DOCUMENT_POSITION_FOLLOWINGは、比較対象のノードが参照ノードの「後に」出現することを示す整数値の定数です。この定数自体に引数はなく、戻り値は整数型の定数値です。同様に、キーワードとして挙げられているDOMNode::DOCUMENT_POSITION_PRECEDINGは、比較対象のノードが参照ノードの「前に」出現することを示します。

コードでは、まずHTMLコンテンツをDOMDocumentオブジェクトにロードし、比較対象となる複数のDOMノード（first-item, middle-item, last-item）を取得しています。

compareDocumentPositionメソッドは、比較したいノードを引数に取り、二つのノード間の位置関係を示すビットフラグ（整数）を戻り値として返します。このビットフラグをDOCUMENT_POSITION_FOLLOWINGやDOCUMENT_POSITION_PRECEDINGといった定数とビットAND演算子（&）で組み合わせることで、ノードが先行しているか、あるいは続いているかなどを正確に判定できます。

例えば、$middleItemから$firstItemを比較する際は$firstItemが$middleItemよりも前に位置するため、結果にはDOCUMENT_POSITION_PRECEDINGが含まれます。逆に$firstItemから$middleItemを比較する際は$middleItemが$firstItemの後に位置するため、結果にはDOCUMENT_POSITION_FOLLOWINGが含まれることが確認できます。

Copy
1<?php
2
3/**
4 * 2つのDOMノードを比較し、2番目のノードが最初のノードの後に来るかどうかを判定します。
5 *
6 * DOMNode::DOCUMENT_POSITION_FOLLOWING は、ターゲットノードが参照ノードの後に続くことを示す定数です。
7 * これは、DOMツリー内でのノードの順序を比較する際に使用されます。
8 *
9 * @param \DOMNode $nodeA 比較対象となる最初のノード。
10 * @param \DOMNode $nodeB 比較対象となる2番目のノード。
11 *                        例えば、HTTP POSTリクエストから受け取ったXML/HTMLデータから
12 *                        構築されたDOMツリーの一部である可能性があります。
13 * @return bool nodeB が nodeA の後に来る場合に true、それ以外の場合に false を返します。
14 */
15function isNodeFollowing(\DOMNode $nodeA, \DOMNode $nodeB): bool
16{
17    // compareDocumentPosition() メソッドは、2つのノード間の位置関係を示すビットマスクを返します。
18    // その結果と DOMNode::DOCUMENT_POSITION_FOLLOWING 定数をビット論理AND演算子 (&) で比較し、
19    // $nodeB が $nodeA の後に位置するかどうかを判断します。
20    return (bool)($nodeA->compareDocumentPosition($nodeB) & DOMNode::DOCUMENT_POSITION_FOLLOWING);
21}
22
23// --- サンプルコードの使用例 ---
24
25// 新しいDOMDocumentを作成し、HTMLコンテンツを読み込みます。
26$dom = new DOMDocument();
27// loadHTML は自動的に正しいエンコーディングとDOCTYPEを処理します。
28$dom->loadHTML('<html><body><div id="container"><span id="first">First Node</span><p id="second">Second Node</p></div></body></html>');
29
30// 比較対象となるノードをIDで取得します。
31$nodeFirst = $dom->getElementById('first');
32$nodeSecond = $dom->getElementById('second');
33$containerNode = $dom->getElementById('container');
34
35echo "--- DOMノードの位置比較 ---" . PHP_EOL;
36
37if ($nodeFirst && $nodeSecond) {
38    // $nodeSecond は $nodeFirst の後に続くので true が返されるはずです。
39    $result1 = isNodeFollowing($nodeFirst, $nodeSecond);
40    echo "ノード 'second' は 'first' の後に来ますか？ " . ($result1 ? 'はい' : 'いいえ') . PHP_EOL; // 出力: はい
41
42    // $nodeFirst は $nodeSecond の後に続かないので false が返されるはずです。
43    $result2 = isNodeFollowing($nodeSecond, $nodeFirst);
44    echo "ノード 'first' は 'second' の後に来ますか？ " . ($result2 ? 'はい' : 'いいえ') . PHP_EOL; // 出力: いいえ
45}
46
47if ($containerNode && $nodeFirst) {
48    // $nodeFirst は $containerNode の中に含まれていますが、直接の後に続くわけではないので false が返されるはずです。
49    $result3 = isNodeFollowing($containerNode, $nodeFirst);
50    echo "ノード 'first' は 'container' の後に来ますか？ " . ($result3 ? 'はい' : 'いいえ') . PHP_EOL; // 出力: いいえ
51}
52
53// 存在しないノードや、異なるドキュメントからのノードを比較する場合は注意が必要です。
54// この例では、常に同じドキュメント内の有効なノードを想定しています。
55
56?>

このPHPコードは、ウェブページなどの文書構造（DOMツリー）において、二つの要素（ノード）がどのような位置関係にあるかを調べる方法を示しています。特に、一つのノードが別のノードの「後に続く」かどうかを判定する際に使用されます。

DOMNode::DOCUMENT_POSITION_FOLLOWING は、PHPでDOM操作を行う際に用いられる特別な定数です。これは、特定のノードが基準となるノードの後に位置している状態を示す整数値であり、ノードの順序を比較する際に判断材料の一つとして使われます。この定数自体が比較を行うのではなく、他のメソッドの結果と組み合わせて利用されます。

サンプルコード内の isNodeFollowing 関数は、比較対象となる最初のノード $nodeA と、二番目のノード $nodeB を引数として受け取ります。例えば、$nodeB はHTTP POSTリクエストで送信されたXMLやHTMLデータから構築されたDOMツリーの一部である可能性も考えられます。関数内部では、$nodeA の compareDocumentPosition メソッドを呼び出し、その戻り値と DOMNode::DOCUMENT_POSITION_FOLLOWING 定数をビット論理AND演算子で組み合わせることで、$nodeB が $nodeA の後に続く場合に true を、それ以外の場合に false を返します。

この機能は、サーバーサイドでウェブページの構造を解析し、特定の要素が意図した順序で配置されているかを確認したい場合などに非常に有効です。