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

Copy
1<?php
2
3/**
4 * DOM ノード間の位置関係を比較し、その結果をDOMNodeクラスの定数を使って解釈するサンプルコードです。
5 * DOMNode::compareDocumentPosition() メソッドは、2つのノード間の位置関係を示すビットマスク（整数値）を返します。
6 * このビットマスクをビットAND演算子 (&) を使って、各定数と比較することで、特定の関係性があるかを確認できます。
7 *
8 * この例では特に、以下の定数に焦点を当ててノードの位置関係を説明します。
9 * - DOMNode::DOCUMENT_POSITION_CONTAINED_BY: 比較対象のノードが参照ノードに含まれている場合。
10 * - DOMNode::DOCUMENT_POSITION_PRECEDING: 比較対象のノードが参照ノードの前に位置している場合。
11 */
12function demonstrateDomNodePositionComparison(): void
13{
14    // 1. DOM ドキュメントと要素の準備
15    // DOMDocumentオブジェクトを作成し、HTML/XMLの要素構造を構築します。
16    $dom = new DOMDocument('1.0', 'UTF-8');
17    $dom->formatOutput = true; // 整形されたXML/HTMLを出力するための設定
18
19    // ルート要素 <root> を作成し、ドキュメントに追加
20    $root = $dom->createElement('root');
21    $dom->appendChild($root);
22
23    // <parent> 要素を作成し、<root> の子として追加
24    $parent = $dom->createElement('parent');
25    $root->appendChild($parent);
26
27    // <child1> 要素を作成し、<parent> の子として追加
28    $child1 = $dom->createElement('child1');
29    $parent->appendChild($child1);
30
31    // <child2> 要素を作成し、<parent> の子として追加（<child1> の兄弟ノード）
32    $child2 = $dom->createElement('child2');
33    $parent->appendChild($child2);
34
35    // <sibling_of_parent> 要素を作成し、<root> の子として追加（<parent> の兄弟ノード）
36    $siblingOfParent = $dom->createElement('sibling_of_parent');
37    $root->appendChild($siblingOfParent);
38
39    echo "--- 構築されたDOMノードの構造 ---\n";
40    echo $dom->saveXML(); // 構築したDOMツリーのXML表現を表示
41    echo "\n-------------------------------\n\n";
42    echo "=== DOM ノードの位置関係の比較 ===\n\n";
43
44    // 2. 比較シナリオ1: 子ノードが親ノードに含まれているか (CONTAINED_BY)
45    // ノードA: <child1>, ノードB: <parent>
46    // 期待される結果: <child1> は <parent> に含まれているため、
47    // DOMNode::DOCUMENT_POSITION_CONTAINED_BY が結果に含まれます。
48    $nodeA = $child1;
49    $nodeB = $parent;
50    echo "比較1: ノードA (<{$nodeA->nodeName}>) と ノードB (<{$nodeB->nodeName}>)\n";
51    $position = $nodeA->compareDocumentPosition($nodeB); // 位置関係を比較
52    echo "  比較結果 (ビットマスク): " . sprintf("0x%02X", $position) . "\n"; // 16進数で表示
53
54    // ビットAND演算子 (&) を使って、特定の定数が結果のビットマスクに含まれているかチェックします。
55    if ($position & DOMNode::DOCUMENT_POSITION_CONTAINED_BY) {
56        echo "  - ノードAはノードBに含まれています (DOMNode::DOCUMENT_POSITION_CONTAINED_BY: 0x" . sprintf("%02X", DOMNode::DOCUMENT_POSITION_CONTAINED_BY) . ")\n";
57    }
58    if ($position & DOMNode::DOCUMENT_POSITION_PRECEDING) {
59        echo "  - ノードAはノードBの前に位置しています (DOMNode::DOCUMENT_POSITION_PRECEDING: 0x" . sprintf("%02X", DOMNode::DOCUMENT_POSITION_PRECEDING) . ")\n";
60    }
61    if ($position & DOMNode::DOCUMENT_POSITION_FOLLOWING) {
62        echo "  - ノードAはノードBの後に位置しています (DOMNode::DOCUMENT_POSITION_FOLLOWING: 0x" . sprintf("%02X", DOMNode::DOCUMENT_POSITION_FOLLOWING) . ")\n";
63    }
64    echo "\n";
65
66    // 3. 比較シナリオ2: 兄弟ノードが前に位置しているか (PRECEDING)
67    // ノードA: <child2>, ノードB: <child1>
68    // 期待される結果: <child2> は <child1> の後に位置するため、
69    // DOMNode::DOCUMENT_POSITION_FOLLOWING が結果に含まれます。
70    // （もし比較を逆にする、つまり ノードA: <child1>, ノードB: <child2> なら PRECEDING が含まれます。）
71    $nodeA = $child2;
72    $nodeB = $child1;
73    echo "比較2: ノードA (<{$nodeA->nodeName}>) と ノードB (<{$nodeB->nodeName}>)\n";
74    $position = $nodeA->compareDocumentPosition($nodeB);
75    echo "  比較結果 (ビットマスク): " . sprintf("0x%02X", $position) . "\n";
76
77    if ($position & DOMNode::DOCUMENT_POSITION_PRECEDING) {
78        echo "  - ノードAはノードBの前に位置しています (DOMNode::DOCUMENT_POSITION_PRECEDING: 0x" . sprintf("%02X", DOMNode::DOCUMENT_POSITION_PRECEDING) . ")\n";
79    }
80    if ($position & DOMNode::DOCUMENT_POSITION_FOLLOWING) {
81        echo "  - ノードAはノードBの後に位置しています (DOMNode::DOCUMENT_POSITION_FOLLOWING: 0x" . sprintf("%02X", DOMNode::DOCUMENT_POSITION_FOLLOWING) . ")\n";
82    }
83    echo "\n";
84
85    // 4. 比較シナリオ3: 異なる階層だが同じ親を持つノード間の位置 (PRECEDING)
86    // ノードA: <parent>, ノードB: <sibling_of_parent>
87    // 期待される結果: <parent> は <sibling_of_parent> の前に位置するため、
88    // DOMNode::DOCUMENT_POSITION_PRECEDING が結果に含まれます。
89    $nodeA = $parent;
90    $nodeB = $siblingOfParent;
91    echo "比較3: ノードA (<{$nodeA->nodeName}>) と ノードB (<{$nodeB->nodeName}>)\n";
92    $position = $nodeA->compareDocumentPosition($nodeB);
93    echo "  比較結果 (ビットマスク): " . sprintf("0x%02X", $position) . "\n";
94
95    if ($position & DOMNode::DOCUMENT_POSITION_PRECEDING) {
96        echo "  - ノードAはノードBの前に位置しています (DOMNode::DOCUMENT_POSITION_PRECEDING: 0x" . sprintf("%02X", DOMNode::DOCUMENT_POSITION_PRECEDING) . ")\n";
97    }
98    if ($position & DOMNode::DOCUMENT_POSITION_FOLLOWING) {
99        echo "  - ノードAはノードBの後に位置しています (DOMNode::DOCUMENT_POSITION_FOLLOWING: 0x" . sprintf("%02X", DOMNode::DOCUMENT_POSITION_FOLLOWING) . ")\n";
100    }
101    echo "\n";
102}
103
104// 関数を実行して、DOMノードの位置比較のデモンストレーションを開始します。
105demonstrateDomNodePositionComparison();

このサンプルコードは、PHPのDOM（Document Object Model）機能を利用し、HTMLやXML文書内の異なるノード間の位置関係をプログラムで比較する方法を示しています。DOMNodeクラスが提供するcompareDocumentPosition()メソッドは、引数を必要とせず、2つのノードが文書内でどのように関連しているかを示す整数値（ビットマスク）を返します。この戻り値は、様々なDOMNode定数、例えばDOMNode::DOCUMENT_POSITION_CONTAINED_BYやDOMNode::DOCUMENT_POSITION_PRECEDINGとビットAND演算子を用いて比較することで、特定の位置関係を判断できます。具体的には、DOMNode::DOCUMENT_POSITION_CONTAINED_BYは、比較対象のノードが参照ノードの内部に含まれている場合に設定されるビットを表し、DOMNode::DOCUMENT_POSITION_PRECEDINGは、比較対象のノードが参照ノードよりも文書内で物理的に前に位置している場合に設定されるビットを表します。コードはまず、仮想的なDOMツリーを構築し、その中の異なる要素ペアについてcompareDocumentPosition()メソッドを呼び出しています。そして、返されたビットマスクをこれらの定数と照合し、「親子の関係にあるか」や「どちらが先に現れるか」といった位置関係を分かりやすく出力しています。これにより、初心者はDOMツリーの構造を理解し、プログラムで要素間の相対的な位置を効率的に特定する方法を学ぶことができます。

Copy
1<?php
2
3/**
4 * DOMノード間の位置関係を比較し、
5 * 一方のノードがもう一方のノードに内包されているか（contained by）を判定するサンプルです。
6 *
7 * DOCUMENT_POSITION_CONTAINED_BY 定数は、DOMNode::compareDocumentPosition メソッドの戻り値として使われ、
8 * 比較対象のノード（$other）が現在のノード（$this）を「内包している」場合に、
9 * そのビットフラグが結果に含まれます。
10 * つまり、$this ノードが $other ノードの「子孫」である場合にこの定数がセットされます。
11 */
12function compareNodePositionContainedBy(): void
13{
14    // 1. 新しいDOMドキュメントを作成します。
15    $dom = new DOMDocument();
16
17    // 2. 親要素と子要素を作成し、ドキュメントツリーに追加します。
18    // 構造: <root><parent><child/></parent><sibling/></root>
19    $rootElement = $dom->createElement('root');
20    $parentElement = $dom->createElement('parent');
21    $childElement = $dom->createElement('child');
22    $siblingElement = $dom->createElement('sibling');
23
24    $dom->appendChild($rootElement);
25    $rootElement->appendChild($parentElement);
26    $parentElement->appendChild($childElement);
27    $rootElement->appendChild($siblingElement); // parent と sibling は同じ root の子
28
29    echo "--- ノード位置関係の比較 (DOCUMENT_POSITION_CONTAINED_BY) ---\n";
30
31    // ケース1: 子ノードが親ノードに内包されているか？
32    // $this が $childElement、 $other が $parentElement です。
33    // $childElement は $parentElement に内包されているため、結果には DOCUMENT_POSITION_CONTAINED_BY が含まれるはずです。
34    $positionForChildAndParent = $childElement->compareDocumentPosition($parentElement);
35
36    echo "\n[比較1] childElement と parentElement の関係:\n";
37    echo "  \$childElement->compareDocumentPosition(\$parentElement) の結果 (ビットマスク): " . $positionForChildAndParent . "\n";
38
39    if ($positionForChildAndParent & DOMNode::DOCUMENT_POSITION_CONTAINED_BY) {
40        echo "  結果: childElement は parentElement に内包されています (つまり、childElement は parentElement の子孫です)。\n";
41    } else {
42        echo "  結果: childElement は parentElement に内包されていません。\n";
43    }
44
45    // ケース2: 親ノードが子ノードに内包されているか？
46    // $this が $parentElement、 $other が $childElement です。
47    // $parentElement は $childElement を内包しているので、DOCUMENT_POSITION_CONTAINED_BY は含まれず、
48    // DOCUMENT_POSITION_CONTAINS (parentElement が childElement を含む) が含まれるはずです。
49    $positionForParentAndChild = $parentElement->compareDocumentPosition($childElement);
50
51    echo "\n[比較2] parentElement と childElement の関係:\n";
52    echo "  \$parentElement->compareDocumentPosition(\$childElement) の結果 (ビットマスク): " . $positionForParentAndChild . "\n";
53
54    if ($positionForParentAndChild & DOMNode::DOCUMENT_POSITION_CONTAINED_BY) {
55        echo "  結果: parentElement は childElement に内包されています。\n";
56    } else {
57        echo "  結果: parentElement は childElement に内包されていません (実際には CONTAINS が含まれます)。\n";
58    }
59    
60    // ケース3: 兄弟ノードが内包されているか？
61    // $this が $childElement、 $other が $siblingElement です。
62    // $childElement と $siblingElement は互いに内包関係にありません。
63    $positionForChildAndSibling = $childElement->compareDocumentPosition($siblingElement);
64    echo "\n[比較3] childElement と siblingElement の関係:\n";
65    echo "  \$childElement->compareDocumentPosition(\$siblingElement) の結果 (ビットマスク): " . $positionForChildAndSibling . "\n";
66
67    if ($positionForChildAndSibling & DOMNode::DOCUMENT_POSITION_CONTAINED_BY) {
68        echo "  結果: childElement は siblingElement に内包されています。\n";
69    } else {
70        echo "  結果: childElement は siblingElement に内包されていません (DOCUMENT_POSITION_DISCONNECTED などが含まれます)。\n";
71    }
72}
73
74// 関数を実行します。
75compareNodePositionContainedBy();

DOCUMENT_POSITION_CONTAINED_BY定数は、PHPのDOM操作において、あるDOMノードが別のノードに「内包されている」（つまり、子孫である）状態を示すための定数です。この定数はDOMNode::compareDocumentPositionメソッドの戻り値として利用され、2つのノード間の相対的な位置関係を整数値（ビットマスク）で表現します。引数はなく、戻り値はint型で、この値にDOCUMENT_POSITION_CONTAINED_BYを示すビットが含まれるかどうかで内包関係を判定します。

サンプルコードでは、DOMDocumentを使ってroot、parent、child、siblingという階層的なノードを作成し、これらの位置関係を比較しています。

まず、ケース1ではchildElementがparentElementに内包されているかを確認します。childElement->compareDocumentPosition($parentElement)の実行結果にはDOCUMENT_POSITION_CONTAINED_BYのビットが含まれるため、「childElementはparentElementに内包されている」という判定結果が出力されます。

次に、ケース2ではparentElementがchildElementに内包されているかを確認します。この場合、parentElementはchildElementを内包しているため、結果にはDOCUMENT_POSITION_CONTAINED_BYは含まれません。

最後に、ケース3ではchildElementとsiblingElementという兄弟ノードを比較します。これらは互いに内包関係にないため、DOCUMENT_POSITION_CONTAINED_BYは結果に含まれないことが確認できます。

このように、この定数を利用することで、DOMツリー内でのノードの親子関係や包含関係を正確に判定し、プログラムのロジックに活用することが可能です。