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

Copy
1<?php
2
3/**
4 * DOMノード間の位置関係を比較し、Dom\Node::DOCUMENT_POSITION_FOLLOWING
5 * および Dom\Node::DOCUMENT_POSITION_PRECEDING 定数の使用例を示します。
6 *
7 * システムエンジニアを目指す初心者向けに、DOMツリー内の要素の位置関係を
8 * Dom\Node::compareDocumentPosition() メソッドとビットマスク定数を用いて確認する方法を説明します。
9 *
10 * 提供されたリファレンス情報では「所属クラス: Dom\XMLDocument」と指定されていますが、
11 * 実際にはこれらの位置関係を示す定数は、Dom\XMLDocument の親クラスである Dom\Node に定義されています。
12 * Dom\XMLDocument のインスタンスから取得したノードも Dom\Node を継承しているため、
13 * Dom\Node::compareDocumentPosition() メソッドを使用し、Dom\Node::DOCUMENT_POSITION_* 定数で結果を評価します。
14 */
15function demonstrateDomNodePositionComparison(): void
16{
17    // 新しいDOM名前空間のXMLDocumentをインスタンス化
18    $dom = new \Dom\XMLDocument();
19
20    // 整形済み出力のために空白を保持しない設定（任意だが表示が綺麗になります）
21    $dom->preserveWhiteSpace = false;
22    $dom->formatOutput = true;
23
24    // ルート要素を作成し、ドキュメントに追加
25    $root = $dom->createElement('root');
26    $dom->appendChild($root);
27
28    // 最初の子要素を作成し、ルート要素に追加
29    $child1 = $dom->createElement('child1');
30    $root->appendChild($child1);
31
32    // 二番目の子要素を作成し、最初の要素の後に挿入
33    $child2 = $dom->createElement('child2');
34    $root->appendChild($child2);
35
36    echo "--- DOMノードの位置関係比較のデモンストレーション ---\n\n";
37
38    // ---------------------------------------------------------------
39    // 比較例 1: child1 から見て child2 がどの位置にあるか
40    // ---------------------------------------------------------------
41    echo "1. child1 から child2 への位置関係を評価:\n";
42    // compareDocumentPositionは、呼び出し元のノード（$child1）から見て
43    // 引数のノード（$child2）がどの位置にあるかを示すビットマスクを返します。
44    $position1_to_2 = $child1->compareDocumentPosition($child2);
45
46    // 結果が Dom\Node::DOCUMENT_POSITION_FOLLOWING であるかをビットAND演算でチェック
47    // $child2 は $child1 の後に続くノードです。
48    if ($position1_to_2 & \Dom\Node::DOCUMENT_POSITION_FOLLOWING) {
49        echo "   - child2 は child1 の 後ろ ('FOLLOWING') に位置します。\n";
50    }
51    // 結果が Dom\Node::DOCUMENT_POSITION_PRECEDING であるかをチェック (このケースでは偽)
52    if ($position1_to_2 & \Dom\Node::DOCUMENT_POSITION_PRECEDING) {
53        echo "   - child2 は child1 の 前 ('PRECEDING') に位置します。\n";
54    }
55    echo "\n";
56
57    // ---------------------------------------------------------------
58    // 比較例 2: child2 から見て child1 がどの位置にあるか
59    // ---------------------------------------------------------------
60    echo "2. child2 から child1 への位置関係を評価:\n";
61    $position2_to_1 = $child2->compareDocumentPosition($child1);
62
63    // 結果が Dom\Node::DOCUMENT_POSITION_FOLLOWING であるかをチェック (このケースでは偽)
64    if ($position2_to_1 & \Dom\Node::DOCUMENT_POSITION_FOLLOWING) {
65        echo "   - child1 は child2 の 後ろ ('FOLLOWING') に位置します。\n";
66    }
67    // 結果が Dom\Node::DOCUMENT_POSITION_PRECEDING であるかをチェック
68    // $child1 は $child2 の前に位置するノードです。
69    if ($position2_to_1 & \Dom\Node::DOCUMENT_POSITION_PRECEDING) {
70        echo "   - child1 は child2 の 前 ('PRECEDING') に位置します。\n";
71    }
72    echo "\n";
73
74    // ---------------------------------------------------------------
75    // 比較例 3: root と child1 の関係 (包含関係も含む)
76    // ---------------------------------------------------------------
77    echo "3. root から child1 への位置関係を評価:\n";
78    $position_root_to_child1 = $root->compareDocumentPosition($child1);
79
80    // $child1 は $root に含まれているため、CONTAINED_BY が真となります。
81    if ($position_root_to_child1 & \Dom\Node::DOCUMENT_POSITION_CONTAINED_BY) {
82        echo "   - child1 は root に 含まれています ('CONTAINED_BY')。\n";
83    }
84    // XMLの文書順では、rootの開始タグの後、child1の前に位置するデータがないため、
85    // child1はrootの"後"に位置すると解釈されることがあります。
86    if ($position_root_to_child1 & \Dom\Node::DOCUMENT_POSITION_FOLLOWING) {
87        echo "   - child1 は root の 後ろ ('FOLLOWING') に位置します。\n";
88    }
89    echo "\n";
90
91    echo "--- 参考情報: 主要な定数の値 ---\n";
92    echo "Dom\\Node::DOCUMENT_POSITION_FOLLOWING:  " . \Dom\Node::DOCUMENT_POSITION_FOLLOWING . " (10進数)\n";
93    echo "Dom\\Node::DOCUMENT_POSITION_PRECEDING:  " . \Dom\Node::DOCUMENT_POSITION_PRECEDING . " (10進数)\n";
94    echo "Dom\\Node::DOCUMENT_POSITION_CONTAINS:    " . \Dom\Node::DOCUMENT_POSITION_CONTAINS . " (10進数)\n";
95    echo "Dom\\Node::DOCUMENT_POSITION_CONTAINED_BY: " . \Dom\Node::DOCUMENT_POSITION_CONTAINED_BY . " (10進数)\n";
96    echo "Dom\\Node::DOCUMENT_POSITION_DISCONNECTED: " . \Dom\Node::DOCUMENT_POSITION_DISCONNECTED . " (10進数)\n";
97}
98
99// 関数を実行
100demonstrateDomNodePositionComparison();

PHP 8で導入されたDOM拡張機能のDom\Node::compareDocumentPosition()メソッドは、XMLドキュメント内の二つのノード間の位置関係を比較します。このメソッドは、呼び出し元のノードから見て引数で指定されたノードがDOMツリー内のどこに位置するかを示すビットマスクの整数値を返します。提供されたリファレンスではDom\XMLDocumentの定数として挙げられていますが、実際にはDom\XMLDocumentの親クラスであるDom\Nodeに定義されており、Dom\XMLDocumentのインスタンスから取得したノードでも利用可能です。

本サンプルコードでは、root、child1、child2という要素を持つ簡単なDOMツリーを作成し、異なるノード間の位置関係を比較しています。例えば、$child1->compareDocumentPosition($child2)は、$child1の後に$child2が続く場合、結果のビットマスクにDom\Node::DOCUMENT_POSITION_FOLLOWINGが含まれます。逆に$child2->compareDocumentPosition($child1)では、$child2の前に$child1が位置する場合、結果にDom\Node::DOCUMENT_POSITION_PRECEDINGが含まれることをビット論理AND演算子（&）で確認しています。この機能は、要素の前後関係だけでなく、包含関係などもプログラムで正確に判断する際に役立ち、DOM操作の高度な制御に利用できます。

Copy
1<?php
2
3/**
4 * 2つのDOMノード間の位置関係を比較し、
5 * 最初のノードが2番目のノードの「後続」であるかを確認します。
6 *
7 * この関数は、DOMNode::compareDocumentPosition() メソッドを使用し、
8 * 結果を DOM_DOCUMENT_POSITION_FOLLOWING 定数と比較します。
9 * （リファレンス情報で指定された Dom\XMLDocument::DOCUMENT_POSITION_FOLLOWING は、
10 * PHP 8の標準DOM拡張では通常 DOM_DOCUMENT_POSITION_FOLLOWING として利用されます。）
11 *
12 * @param \DOMNode $nodeA 比較する最初のノード。このノードの位置を確認します。
13 * @param \DOMNode $nodeB 比較する基準となるノード。$nodeAがこのノードの後に来るかを確認します。
14 * @return bool $nodeAが$nodeBの「後続」である場合はtrue、そうでない場合はfalseを返します。
15 */
16function checkDocumentPositionFollowing(\DOMNode $nodeA, \DOMNode $nodeB): bool
17{
18    // compareDocumentPositionメソッドは、2つのノード間の位置関係を示すビットマスクを返します。
19    // 例: DOM_DOCUMENT_POSITION_FOLLOWING (ノードAがノードBの後に来る)
20    //     DOM_DOCUMENT_POSITION_PRECEDING (ノードAがノードBの前に来る) など
21    $position = $nodeA->compareDocumentPosition($nodeB);
22
23    // ビットAND演算子（&）を使って、戻り値にDOM_DOCUMENT_POSITION_FOLLOWINGが含まれているかチェックします。
24    // もし戻り値にこのビットが含まれていれば、$nodeAは$nodeBの後に位置します。
25    return (bool)($position & DOM_DOCUMENT_POSITION_FOLLOWING);
26}
27
28// --- 単体で動作可能なコード例 ---
29
30// 新しいDOMドキュメントを作成し、XMLをロードします。
31$dom = new \DOMDocument();
32// ドキュメント内のID属性で要素を識別できるように、trueを設定します。
33$dom->loadXML('<root><elementA id="A"/><elementB id="B"/><elementC id="C"/></root>');
34
35// 比較対象となるDOMノードをIDで取得します。
36$nodeA = $dom->getElementById('A');
37$nodeB = $dom->getElementById('B');
38$nodeC = $dom->getElementById('C');
39
40// ノードが正しく取得できたか確認し、比較を実行します。
41if ($nodeA && $nodeB && $nodeC) {
42    echo "--- ノード位置の比較結果 ---" . PHP_EOL;
43
44    // elementBがelementAの後に来るか？ (XML構造上、BはAの後に来るので true)
45    echo "elementB が elementA の後続か: " . (checkDocumentPositionFollowing($nodeB, $nodeA) ? 'はい' : 'いいえ') . PHP_EOL;
46
47    // elementAがelementBの後に来るか？ (XML構造上、AはBの後に来ないので false)
48    echo "elementA が elementB の後続か: " . (checkDocumentPositionFollowing($nodeA, $nodeB) ? 'はい' : 'いいえ') . PHP_EOL;
49    
50    // elementCがelementAの後に来るか？ (XML構造上、CはAの後に来るので true)
51    echo "elementC が elementA の後続か: " . (checkDocumentPositionFollowing($nodeC, $nodeA) ? 'はい' : 'いいえ') . PHP_EOL;
52} else {
53    echo "警告: サンプルノードの取得に失敗しました。XML構造を確認してください。\n";
54}

このPHPコードは、XMLドキュメント内で指定された二つのノードの相対的な位置関係を比較し、最初のノードが二番目のノードの「後続」であるかを確認するためのものです。checkDocumentPositionFollowing関数は、比較対象となる最初のノードを$nodeA、基準となる二番目のノードを$nodeBとして、それぞれ\DOMNode型の引数で受け取ります。

関数内部では、$nodeAが持つcompareDocumentPosition()メソッドを呼び出し、$nodeBとの位置関係を数値として取得します。このメソッドは、ノード間の様々な位置関係（先行、後続、包含など）を示すビットマスクと呼ばれる整数値を返します。次に、ビットAND演算子（&）を使用して、その戻り値にDOM_DOCUMENT_POSITION_FOLLOWING定数が含まれているかをチェックします。このDOM_DOCUMENT_POSITION_FOLLOWINGは、リファレンス情報にあるDom\XMLDocument::DOCUMENT_POSITION_FOLLOWINGに相当する定数で、PHPのDOM拡張機能においてノードが後続の位置にあることを示します。

最終的に、$nodeAが$nodeBのXMLツリー内で物理的に後に位置している場合（つまり、compareDocumentPosition()の戻り値にDOM_DOCUMENT_POSITION_FOLLOWINGのビットが含まれている場合）はtrueを返します。それ以外の場合、例えば$nodeAが$nodeBの前に位置しているか、全く異なるブランチにある場合はfalseを返します。この関数は、DOMツリーの構造を把握し、ノードの順序に基づいた処理を行う際に利用されます。