【PHP8.x】Dom\DocumentFragment::DOCUMENT_POSITION_FOLLOWING定数の使い方

Copy
1<?php
2
3/**
4 * DOMノード間の位置関係を比較する関数
5 *
6 * この関数は、PHPのDOM拡張機能とDom\DocumentFragmentクラスの定数を使用して、
7 * 2つのDOMノード間の相対的な位置関係を判定する方法を示します。
8 * 特に、DOMNode::compareDocumentPosition() メソッドと
9 * Dom\DocumentFragment::DOCUMENT_POSITION_FOLLOWING
10 * および Dom\DocumentFragment::DOCUMENT_POSITION_PRECEDING
11 * 定数の使用例に焦点を当てています。
12 */
13function demonstrateDomNodeComparison(): void
14{
15    // 1. 新しいDOMドキュメントを作成します。
16    // ドキュメントはHTMLやXMLのようなツリー構造のデータを扱います。
17    $dom = new DOMDocument();
18    $dom->formatOutput = true; // 出力を人間が読みやすいように整形します。
19
20    // 2. ルート要素を作成し、ドキュメントに追加します。
21    // 全ての要素の親となる最も上位の要素です。
22    $rootElement = $dom->createElement('root');
23    $dom->appendChild($rootElement);
24
25    // 3. 2つの子要素を作成し、ルート要素に追加します。
26    // これらが比較対象となるノードです。
27    $nodeA = $dom->createElement('nodeA', '最初のノード');
28    $rootElement->appendChild($nodeA); // nodeAをrootElementに追加
29
30    $nodeB = $dom->createElement('nodeB', '次のノード');
31    $rootElement->appendChild($nodeB); // nodeBをrootElementに追加 (nodeAの後に追加される)
32
33    echo "--- 現在のDOMドキュメント構造 ---\n";
34    echo $dom->saveXML(); // ドキュメントのXML表現を出力します。
35    echo "---------------------------------\n\n";
36
37    // 4. ノードAとノードBの位置関係を比較します。
38    // compareDocumentPosition() メソッドは、2つのノード間の位置関係を示すビットマスクを返します。
39    // 例: Dom\DocumentFragment::DOCUMENT_POSITION_FOLLOWING は 0x02 (2進数: 0010)
40    //     Dom\DocumentFragment::DOCUMENT_POSITION_PRECEDING は 0x04 (2進数: 0100)
41    // これらの定数は Dom\DocumentFragment クラスに定義されていますが、
42    // compareDocumentPosition() メソッドは DOMNode クラスに属します。
43    $positionAB = $nodeA->compareDocumentPosition($nodeB);
44
45    echo "ノードA（{$nodeA->nodeName}）とノードB（{$nodeB->nodeName}）を比較します。\n";
46    echo "  \$nodeA->compareDocumentPosition(\$nodeB) の結果（16進数）: "
47        . sprintf("0x%X", $positionAB) . "\n";
48
49    // 5. 結果を Dom\DocumentFragment の定数と比較して解釈します。
50    // ビットAND演算子 (&) を使用して、返された値に特定の位置関係のビットが含まれているかを確認します。
51
52    // ノードBがノードAの「後方」にあるかを確認します。
53    if ($positionAB & Dom\DocumentFragment::DOCUMENT_POSITION_FOLLOWING) {
54        echo "  -> 結果: ノードB は ノードA の 後方 にあります。\n";
55    } else {
56        echo "  -> 結果: ノードB は ノードA の 後方 にありません。\n";
57    }
58
59    // ノードBがノードAの「前方」にあるかを確認します。
60    // この例では、ノードBはノードAの後に追加されたため、「前方」にはありません。
61    if ($positionAB & Dom\DocumentFragment::DOCUMENT_POSITION_PRECEDING) {
62        echo "  -> 結果: ノードB は ノードA の 前方 にあります。\n";
63    } else {
64        echo "  -> 結果: ノードB は ノードA の 前方 にはありません。\n";
65    }
66
67    echo "\n";
68
69    // 6. 逆の比較も行ってみましょう（ノードBとノードA）。
70    // 比較するノードの順序を逆にすると、結果も逆になります。
71    $positionBA = $nodeB->compareDocumentPosition($nodeA);
72
73    echo "ノードB（{$nodeB->nodeName}）とノードA（{$nodeA->nodeName}）を比較します。\n";
74    echo "  \$nodeB->compareDocumentPosition(\$nodeA) の結果（16進数）: "
75        . sprintf("0x%X", $positionBA) . "\n";
76
77    // ノードAがノードBの「後方」にあるかを確認します。
78    // この例では、ノードAはノードBの前に配置されているため、「後方」にはありません。
79    if ($positionBA & Dom\DocumentFragment::DOCUMENT_POSITION_FOLLOWING) {
80        echo "  -> 結果: ノードA は ノードB の 後方 にあります。\n";
81    } else {
82        echo "  -> 結果: ノードA は ノードB の 後方 にはありません。\n";
83    }
84
85    // ノードAがノードBの「前方」にあるかを確認します。
86    if ($positionBA & Dom\DocumentFragment::DOCUMENT_POSITION_PRECEDING) {
87        echo "  -> 結果: ノードA は ノードB の 前方 にあります。\n";
88    } else {
89        echo "  -> 結果: ノードA は ノードB の 前方 にはありません。\n";
90    }
91}
92
93// 上記で定義した比較関数を実行します。
94demonstrateDomNodeComparison();
95

このPHPコードは、ウェブページの構造を表すDOMノード間の相対的な位置関係を比較する方法を示しています。PHP 8のDOM拡張機能を使用し、DOMNodeクラスに属するcompareDocumentPosition()メソッドと、Dom\DocumentFragmentクラスで定義されている定数DOCUMENT_POSITION_FOLLOWINGおよびDOCUMENT_POSITION_PRECEDINGを用いてノードの位置を判定します。

compareDocumentPosition()メソッドは、2つのDOMノードを比較し、基準となるノードに対して比較対象のノードが「前方」にあるか「後方」にあるかといった位置関係を示す整数値を返します。この戻り値は単一の特定の状態を示すのではなく、複数の位置関係をビットフラグとして組み合わせたものです。

例えば、Dom\DocumentFragment::DOCUMENT_POSITION_FOLLOWING定数は、比較対象のノードが基準ノードの「後方」に位置する場合に、その特定のビット（整数値）を表します。同様に、DOCUMENT_POSITION_PRECEDING定数は「前方」にある場合を示します。

サンプルコードでは、まずDOMドキュメント内にnodeAとnodeBという2つの要素を作成し、nodeAの後にnodeBを追加しています。その後、$nodeA->compareDocumentPosition($nodeB)を実行すると、nodeBがnodeAの「後方」にあるため、返された整数値にはDOCUMENT_POSITION_FOLLOWINGを示すビットが含まれます。この確認は、ビットAND演算子（&）を使って戻り値と定数を比較することで行われます。このようにして、DOMツリー内の要素が互いにどのような位置にあるかをプログラム的に判断することができます。

Copy
1<?php
2
3/**
4 * PHPのDOMノードの位置関係を比較し、指定されたノードが参照ノードの後に続くかどうかを判定します。
5 *
6 * この関数は、Dom\Node::compareDocumentPosition メソッドを使用し、
7 * Dom\DocumentFragment::DOCUMENT_POSITION_FOLLOWING 定数とのビットマスク比較を行います。
8 * DOCUMENT_POSITION_FOLLOWING は、`$otherNode` が `$referenceNode` の後にDOMツリーの走査順で現れることを示します。
9 *
10 * @param \DOMNode $referenceNode 比較の基準となるノード。
11 * @param \DOMNode $otherNode 参照ノードと比較されるノード。
12 * @return bool `$otherNode` が `$referenceNode` の後に続く場合に true、そうでない場合は false。
13 */
14function isNodeFollowing(\DOMNode $referenceNode, \DOMNode $otherNode): bool
15{
16    // compareDocumentPosition メソッドは、2つのノード間の位置関係を示すビットマスクを返します。
17    // 例えば、<parent><child/></parent> の場合、DOMツリーの走査順では
18    // <parent>の後に<child>が来るため、childはparentの後に続くと判定されることがあります。
19    $position = $referenceNode->compareDocumentPosition($otherNode);
20
21    // DOCUMENT_POSITION_FOLLOWING は、otherNode が referenceNode の後にDOMツリーの走査順で
22    // 現れることを示すフラグです。
23    // ビットAND演算子 (&) を使用して、戻り値が DOCUMENT_POSITION_FOLLOWING フラグを含むかチェックします。
24    return (bool)($position & \Dom\DocumentFragment::DOCUMENT_POSITION_FOLLOWING);
25}
26
27// サンプルHTMLドキュメントを作成
28$dom = new \DOMDocument();
29// HTMLをロードする際、エラーが発生しないように@を付けています。
30@$dom->loadHTML('<div id="container"><span id="first">First Node</span><p id="second">Second Node</p></div>');
31
32// 比較対象となるノードをIDで取得
33$firstNode = $dom->getElementById('first');
34$secondNode = $dom->getElementById('second');
35$containerNode = $dom->getElementById('container');
36
37// 必要なノードが全て見つかったか確認
38if ($firstNode && $secondNode && $containerNode) {
39    echo "--- ノード位置関係の比較 --- \n";
40
41    // ケース1: 兄弟ノード間の比較
42    echo "基準ノード: 'first' (span), 比較対象ノード: 'second' (p)\n";
43    // 'second' (p) は 'first' (span) の後にDOMツリー上で出現します。
44    echo "  'second' は 'first' の後に続くか? " . (isNodeFollowing($firstNode, $secondNode) ? "Yes" : "No") . " (期待: Yes)\n\n";
45
46    // ケース2: 兄弟ノード間の逆の比較
47    echo "基準ノード: 'second' (p), 比較対象ノード: 'first' (span)\n";
48    // 'first' (span) は 'second' (p) の前にDOMツリー上で出現します。
49    echo "  'first' は 'second' の後に続くか? " . (isNodeFollowing($secondNode, $firstNode) ? "Yes" : "No") . " (期待: No)\n\n";
50
51    // ケース3: 親子ノード間の比較 (子が親の後に続くか)
52    echo "基準ノード: 'container' (div), 比較対象ノード: 'first' (span)\n";
53    // 'first' (span) は 'container' (div) の子であり、DOMツリー上も親の後に続きます。
54    echo "  'first' は 'container' の後に続くか? " . (isNodeFollowing($containerNode, $firstNode) ? "Yes" : "No") . " (期待: Yes)\n\n";
55
56    // ケース4: 親子ノード間の比較 (親が子の後に続くか)
57    echo "基準ノード: 'first' (span), 比較対象ノード: 'container' (div)\n";
58    // 'container' (div) は 'first' (span) の親であり、DOMツリー上は子の前に出現します。
59    echo "  'container' は 'first' の後に続くか? " . (isNodeFollowing($firstNode, $containerNode) ? "Yes" : "No") . " (期待: No)\n";
60
61} else {
62    echo "エラー: 必要なノードがDOMドキュメントに見つかりませんでした。\n";
63}
64

このPHPコードは、ウェブページの構造を表すDOM（Document Object Model）ツリーにおいて、あるノードが別のノードの「後に続く」位置にあるかどうかを判定するisNodeFollowing関数を提供します。この関数は、比較の基準となるノードを$referenceNode、比較対象のノードを$otherNodeとして受け取ります。そして、$otherNodeが$referenceNodeよりもDOMツリーの走査順で後に出現する場合にtrueを、そうでない場合にfalseを返します。

関数内部では、$referenceNodeが持つcompareDocumentPositionメソッドが使用されます。このメソッドは、$referenceNodeと$otherNodeの間の詳細な位置関係を数値（ビットマスク）として返します。次に、その戻り値とDom\DocumentFragment::DOCUMENT_POSITION_FOLLOWING定数をビットAND演算子&で比較します。DOCUMENT_POSITION_FOLLOWING定数は、$otherNodeが$referenceNodeの後にDOMツリーの走査順で現れることを示す特定のフラグです。この比較により、$otherNodeが$referenceNodeの後に続いている場合にのみ、結果がtrueとなります。

サンプルコードでは、シンプルなHTMLドキュメントを読み込み、「first (span)」「second (p)」「container (div)」というノードを取得しています。これらのノードを様々な組み合わせでisNodeFollowing関数に渡し、兄弟ノード間（例: firstとsecond）や親子ノード間（例: containerとfirst）での位置関係がどのように判定されるか、具体的な実行結果とともに示しています。これにより、DOMノードの位置関係判定の挙動を明確に理解することができます。