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

Copy
1<?php
2
3/**
4 * DOMNode::DOCUMENT_POSITION_CONTAINED_BY 定数と
5 * DOMNode::DOCUMENT_POSITION_PRECEDING 定数の使用例を示します。
6 *
7 * DOMNode::compareDocumentPosition() メソッドは、
8 * 2つのDOMノード間の相対的な位置関係を示す整数値（ビットマスク）を返します。
9 * これらの定数をビット論理積 (&) と共に使用することで、
10 * 返された値から特定のノード関係（例: 含まれているか、前に位置するか）を判断できます。
11 *
12 * - DOMNode::DOCUMENT_POSITION_CONTAINED_BY:
13 *   compareDocumentPosition() を呼び出したノードが、引数として渡されたノードによって
14 *   '含まれている'（子孫である）場合にこのビットがセットされます。
15 *
16 * - DOMNode::DOCUMENT_POSITION_PRECEDING:
17 *   compareDocumentPosition() を呼び出したノードが、引数として渡されたノードよりも
18 *   ドキュメントツリー上で'前'に位置する場合にこのビットがセットされます。
19 */
20function demonstrateDomNodePositionComparison(): void
21{
22    // 1. DOMDocumentを作成し、簡単なHTML構造をロードします。
23    $dom = new DOMDocument();
24    // HTMLのパースエラーを抑制し、より柔軟に処理します。
25    libxml_use_internal_errors(true);
26    $dom->loadHTML('
27        <div id="parentDiv">
28            <p id="firstParagraph">
29                <span id="childSpan">これは子要素のspanです。</span>
30            </p>
31            <p id="secondParagraph">これは2番目のp要素です。</p>
32        </div>
33    ');
34    libxml_clear_errors(); // エラー情報をクリアします。
35
36    // 2. 比較に使用するノードを取得します。
37    $parentDiv = $dom->getElementById('parentDiv');
38    $firstParagraph = $dom->getElementById('firstParagraph');
39    $childSpan = $dom->getElementById('childSpan');
40    $secondParagraph = $dom->getElementById('secondParagraph');
41
42    // ノードが正しく取得できたかを確認します。
43    if (!$parentDiv || !$firstParagraph || !$childSpan || !$secondParagraph) {
44        echo "エラー: 必要なDOM要素の一部または全てが見つかりませんでした。\n";
45        return;
46    }
47
48    echo "--- DOMノードの位置関係の比較例 ---\n\n";
49
50    // --- 例1: DOCUMENT_POSITION_CONTAINED_BY の使用 ---
51    // childSpan が firstParagraph に含まれているかを確認します。
52    // (childSpan は firstParagraph の子孫です)
53    $position1 = $childSpan->compareDocumentPosition($firstParagraph);
54    echo "1. childSpan と firstParagraph の比較:\n";
55    echo "   childSpan->compareDocumentPosition(firstParagraph) の結果: " . $position1 . "\n";
56
57    // DOCUMENT_POSITION_CONTAINED_BY フラグがセットされているかを確認します。
58    if (($position1 & DOMNode::DOCUMENT_POSITION_CONTAINED_BY) === DOMNode::DOCUMENT_POSITION_CONTAINED_BY) {
59        echo "   -> childSpan は firstParagraph に『含まれています』。\n";
60    } else {
61        echo "   -> childSpan は firstParagraph に『含まれていません』。\n";
62    }
63    // DOCUMENT_POSITION_PRECEDING フラグはセットされていないはずです。
64    if (($position1 & DOMNode::DOCUMENT_POSITION_PRECEDING) === DOMNode::DOCUMENT_POSITION_PRECEDING) {
65        echo "   -> (補足) childSpan は firstParagraph の『前に位置します』。(これは正しくありません)\n";
66    } else {
67        echo "   -> (補足) childSpan は firstParagraph の『前に位置しません』。\n";
68    }
69    echo "\n";
70
71    // --- 例2: DOCUMENT_POSITION_PRECEDING の使用 ---
72    // firstParagraph が secondParagraph の前に位置するかを確認します。
73    // (firstParagraph は secondParagraph より先にドキュメントに現れます)
74    $position2 = $firstParagraph->compareDocumentPosition($secondParagraph);
75    echo "2. firstParagraph と secondParagraph の比較:\n";
76    echo "   firstParagraph->compareDocumentPosition(secondParagraph) の結果: " . $position2 . "\n";
77
78    // DOCUMENT_POSITION_PRECEDING フラグがセットされているかを確認します。
79    if (($position2 & DOMNode::DOCUMENT_POSITION_PRECEDING) === DOMNode::DOCUMENT_POSITION_PRECEDING) {
80        echo "   -> firstParagraph は secondParagraph の『前に位置します』。\n";
81    } else {
82        echo "   -> firstParagraph は secondParagraph の『前に位置しません』。\n";
83    }
84    // DOCUMENT_POSITION_CONTAINED_BY フラグはセットされていないはずです。
85    if (($position2 & DOMNode::DOCUMENT_POSITION_CONTAINED_BY) === DOMNode::DOCUMENT_POSITION_CONTAINED_BY) {
86        echo "   -> (補足) firstParagraph は secondParagraph に『含まれています』。(これは正しくありません)\n";
87    } else {
88        echo "   -> (補足) firstParagraph は secondParagraph に『含まれていません』。\n";
89    }
90    echo "\n";
91}
92
93// 定義した関数を実行します。
94demonstrateDomNodePositionComparison();

このPHPのサンプルコードは、DOM（Document Object Model）ツリーにおける2つのノード間の相対的な位置関係を判定する方法を示しています。ここでは特に、DOMNode::DOCUMENT_POSITION_CONTAINED_BYとDOMNode::DOCUMENT_POSITION_PRECEDINGという二つの定数に焦点を当てています。

DOMNode::compareDocumentPosition()メソッドは、呼び出し元のノードと引数として渡されたノードの位置を比較し、その結果を整数値のビットマスクとして返します。この戻り値は、様々な位置関係を表す複数の情報を同時に含んでいます。

DOMNode::DOCUMENT_POSITION_CONTAINED_BY定数は、呼び出し元のノードが引数のノードによって「含まれている」、つまり子孫である場合に、compareDocumentPosition()メソッドの戻り値に含まれるビットフラグです。この定数自体は引数を取らず、整数値を返します。

一方、DOMNode::DOCUMENT_POSITION_PRECEDING定数は、呼び出し元のノードが引数のノードよりもドキュメントツリー上で「前」に位置する場合にセットされるビットフラグです。こちらも引数はなく、整数値を返します。

サンプルコードでは、まずHTML構造を持つDOMDocumentを作成し、特定のノードを取得しています。その後、compareDocumentPosition()メソッドの戻り値とこれらの定数をビット論理積演算子&を使って比較することで、ノードが「含まれている」か、あるいは「前に位置する」かといった具体的な関係を判定し、その結果を出力しています。これにより、複雑なDOM構造内でのノード間の位置関係をプログラムで正確に把握できることがわかります。

Copy
1<?php
2
3/**
4 * DOMNode::DOCUMENT_POSITION_CONTAINED_BY 定数の使用例を示します。
5 * DOMツリーにおけるノード間の位置関係（包含関係）を判定します。
6 */
7function demonstrateDomNodePositionComparison(): void
8{
9    // DOMDocument オブジェクトを作成し、シンプルなHTML構造をロード
10    $dom = new DOMDocument('1.0', 'UTF-8');
11    // エラーを抑制し、HTMLの厳密な形式要件を緩和してシンプルな文字列をロード
12    @$dom->loadHTML('<div id="parent"><span id="child">Hello PHP</span></div>');
13
14    // DOMツリーから特定のIDを持つノードを取得
15    $parentNode = $dom->getElementById('parent');
16    $childNode = $dom->getElementById('child');
17
18    // ノードが正しく取得できたか確認
19    if (!$parentNode || !$childNode) {
20        echo "エラー: 親ノードまたは子ノードが見つかりませんでした。\n";
21        return;
22    }
23
24    echo "--- DOMノードの位置関係の比較 ---\n";
25    echo "親ノード: <" . $parentNode->nodeName . " id=\"" . $parentNode->getAttribute('id') . "\">\n";
26    echo "子ノード: <" . $childNode->nodeName . " id=\"" . $childNode->getAttribute('id') . "\">\n\n";
27
28    // 1. 子ノードから親ノードへの位置関係を比較
29    // ここでは「子ノードが親ノードに『含まれている』か」を判定します。
30    $childToParentPosition = $childNode->compareDocumentPosition($parentNode);
31
32    echo "比較: 子ノード から 親ノード へ\n";
33    // compareDocumentPosition の戻り値はビットマスクの整数値です。
34    // 各ビットが特定の位置関係を示します。
35    echo "結果のビットマスク値: " . $childToParentPosition . "\n";
36
37    // DOCUMENT_POSITION_CONTAINED_BY 定数を使って、子ノードが親ノードに含まれているかチェック
38    // ビットAND演算子 (&) を使用して、特定のビット（定数の値）がセットされているかを確認します。
39    if (($childToParentPosition & DOMNode::DOCUMENT_POSITION_CONTAINED_BY) === DOMNode::DOCUMENT_POSITION_CONTAINED_BY) {
40        echo "  - 「" . $childNode->nodeName . "」は「" . $parentNode->nodeName . "」に「含まれています」 (DOCUMENT_POSITION_CONTAINED_BY).\n";
41    } else {
42        echo "  - 「" . $childNode->nodeName . "」は「" . $parentNode->nodeName . "」に「含まれていません」.\n";
43    }
44
45    echo "\n";
46
47    // 2. 親ノードから子ノードへの位置関係を比較
48    // ここでは「親ノードが子ノードを『含んでいる』か」を判定します。
49    $parentToChildPosition = $parentNode->compareDocumentPosition($childNode);
50
51    echo "比較: 親ノード から 子ノード へ\n";
52    echo "結果のビットマスク値: " . $parentToChildPosition . "\n";
53
54    // DOCUMENT_POSITION_CONTAINS 定数を使って、親ノードが子ノードを含んでいるかチェック
55    // キーワード 'document_position_contains' に関連する別の定数も示します。
56    if (($parentToChildPosition & DOMNode::DOCUMENT_POSITION_CONTAINS) === DOMNode::DOCUMENT_POSITION_CONTAINS) {
57        echo "  - 「" . $parentNode->nodeName . "」は「" . $childNode->nodeName . "」を「含んでいます」 (DOCUMENT_POSITION_CONTAINS).\n";
58    } else {
59        echo "  - 「" . $parentNode->nodeName . "」は「" . $childNode->nodeName . "」を「含んでいません」.\n";
60    }
61}
62
63// 定義した関数を実行して、DOMノードの位置関係の比較を示します。
64demonstrateDomNodePositionComparison();
65
66?>

PHPのDOMNode::DOCUMENT_POSITION_CONTAINED_BY定数は、ウェブページの構造を表すDOM（Document Object Model）ツリーにおいて、ノード間の包含関係、つまり「あるノードが別のノードに『含まれている』か」を判定するために使用される定数です。この定数自体に引数はなく、特定の意味を持つ整数値として定義されています。

この定数は、主にDOMNodeクラスのcompareDocumentPosition()メソッドと組み合わせて利用されます。compareDocumentPosition()メソッドは、比較対象となるDOMNodeオブジェクトを引数として受け取り、二つのノード間の相対的な位置関係を示すビットマスク形式の整数値を戻り値として返します。

サンプルコードでは、まずHTMLドキュメントをロードし、div要素を親ノード、その内部にあるspan要素を子ノードとして取得しています。次に、子ノードから親ノードへの位置関係をcompareDocumentPosition()で比較し、その結果とDOMNode::DOCUMENT_POSITION_CONTAINED_BY定数をビットAND演算子（&）で組み合わせることで、子ノードが親ノードの内部に位置しているかどうかを正確に判断しています。

また、キーワードにあるdocument_position_containsに関連して、DOMNode::DOCUMENT_POSITION_CONTAINS定数も存在します。これは逆に「あるノードが別のノードを『含んでいる』か」を判定する際に利用されるもので、サンプルコードでも親ノードから子ノードへの包含関係の判定に用いられています。これらの定数を使用することで、複雑なHTML構造における要素の親子関係や包含関係をプログラムで簡単に確認し、適切な処理を行うことができます。