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

Copy
1<?php
2
3/**
4 * DOMノード間の位置関係を比較し、結果を出力する関数。
5 * DOMNode::compareDocumentPosition() メソッドと、DOM_DOCUMENT_POSITION_PRECEDING
6 * DOM_DOCUMENT_POSITION_FOLLOWING などの関連定数の使用例を示します。
7 */
8function demonstrateDomNodePositionComparison(): void
9{
10    // 1. 新しいDOMドキュメントを作成
11    $dom = new DOMDocument('1.0', 'UTF-8');
12    $dom->formatOutput = true; // 出力時にXMLを整形
13
14    // 2. ルート要素 'root' を作成し、ドキュメントに追加
15    $rootElement = $dom->createElement('root');
16    $dom->appendChild($rootElement);
17
18    // 3. 子要素を作成し、ツリー構造を構築
19    $child1 = $dom->createElement('child1');
20    $rootElement->appendChild($child1);
21
22    $child2 = $dom->createElement('child2');
23    $rootElement->appendChild($child2);
24
25    $grandchild = $dom->createElement('grandchild');
26    $child1->appendChild($grandchild);
27
28    // 4. 比較対象となるノードを準備
29    $nodeA = $child1;      // <child1>
30    $nodeB = $child2;      // <child2>
31    $nodeC = $grandchild;  // <grandchild> (child1の子)
32
33    echo "--- DOMノード間の位置関係の比較 ---" . PHP_EOL;
34
35    // 比較例 1: nodeA (child1) と nodeB (child2)
36    // nodeB は nodeA の後に位置します。
37    echo PHP_EOL . "--- {$nodeA->nodeName} と {$nodeB->nodeName} の比較 ---" . PHP_EOL;
38    $positionResult = $nodeA->compareDocumentPosition($nodeB);
39    echo "  - '{$nodeA->nodeName}' が基準です。" . PHP_EOL;
40    echo "  - '{$nodeB->nodeName}' は、'{$nodeA->nodeName}' に対して...";
41    if ($positionResult & DOM_DOCUMENT_POSITION_FOLLOWING) {
42        echo "後に位置しています (DOM_DOCUMENT_POSITION_FOLLOWING)。" . PHP_EOL;
43    } else {
44        echo "それ以外の関係です。" . PHP_EOL;
45    }
46
47    // 比較例 2: nodeB (child2) と nodeA (child1)
48    // nodeA は nodeB の前に位置します。
49    echo PHP_EOL . "--- {$nodeB->nodeName} と {$nodeA->nodeName} の比較 ---" . PHP_EOL;
50    $positionResult = $nodeB->compareDocumentPosition($nodeA);
51    echo "  - '{$nodeB->nodeName}' が基準です。" . PHP_EOL;
52    echo "  - '{$nodeA->nodeName}' は、'{$nodeB->nodeName}' に対して...";
53    if ($positionResult & DOM_DOCUMENT_POSITION_PRECEDING) {
54        echo "前に位置しています (DOM_DOCUMENT_POSITION_PRECEDING)。" . PHP_EOL;
55    } else {
56        echo "それ以外の関係です。" . PHP_EOL;
57    }
58
59    // 比較例 3: nodeA (child1) と nodeC (grandchild)
60    // nodeA は nodeC を含んでいます。
61    echo PHP_EOL . "--- {$nodeA->nodeName} と {$nodeC->nodeName} の比較 ---" . PHP_EOL;
62    $positionResult = $nodeA->compareDocumentPosition($nodeC);
63    echo "  - '{$nodeA->nodeName}' が基準です。" . PHP_EOL;
64    echo "  - '{$nodeC->nodeName}' は、'{$nodeA->nodeName}' に対して...";
65    if ($positionResult & DOM_DOCUMENT_POSITION_CONTAINS) {
66        echo "含まれています (DOM_DOCUMENT_POSITION_CONTAINS)。" . PHP_EOL;
67    }
68    if ($positionResult & DOM_DOCUMENT_POSITION_CONTAINED_BY) {
69        // これは同時に発生しない
70        echo "これに含まれています (DOM_DOCUMENT_POSITION_CONTAINED_BY)。" . PHP_EOL;
71    }
72
73    // 比較例 4: nodeC (grandchild) と nodeA (child1)
74    // nodeC は nodeA に含まれています。
75    echo PHP_EOL . "--- {$nodeC->nodeName} と {$nodeA->nodeName} の比較 ---" . PHP_EOL;
76    $positionResult = $nodeC->compareDocumentPosition($nodeA);
77    echo "  - '{$nodeC->nodeName}' が基準です。" . PHP_EOL;
78    echo "  - '{$nodeA->nodeName}' は、'{$nodeC->nodeName}' に対して...";
79    if ($positionResult & DOM_DOCUMENT_POSITION_CONTAINS) {
80        echo "含んでいます (DOM_DOCUMENT_POSITION_CONTAINS)。" . PHP_EOL;
81    }
82    if ($positionResult & DOM_DOCUMENT_POSITION_CONTAINED_BY) {
83        echo "含まれています (DOM_DOCUMENT_POSITION_CONTAINED_BY)。" . PHP_EOL;
84    }
85
86    // 生成されたDOMツリーのXML表現を出力 (参考)
87    echo PHP_EOL . "--- 生成されたDOMツリー (参考) ---" . PHP_EOL;
88    echo $dom->saveXML() . PHP_EOL;
89}
90
91// 関数を実行し、DOMノードの位置比較の結果を表示
92demonstrateDomNodePositionComparison();

このPHPサンプルコードは、XMLドキュメント内のノード（要素など）同士がどのような位置関係にあるかをプログラムで確認する方法を示しています。具体的には、DOMDocumentクラスを使ってXMLツリーを構築し、DOMNodeクラスのcompareDocumentPosition()メソッドを用いて二つのノードを比較します。

DOM_DOCUMENT_POSITION_FOLLOWING定数は、compareDocumentPosition()メソッドが返す整数値の一部で、比較対象のノードが基準となるノードの「後に」位置する場合に設定されるフラグです。同様に、DOM_DOCUMENT_POSITION_PRECEDING定数は、比較対象のノードが基準ノードの「前に」位置することを示します。compareDocumentPosition()メソッドは、引数として比較したいノードを受け取り、基準ノードに対する引数ノードの位置関係を複合的な整数値として返します。この戻り値は、様々な位置関係を表す定数（引数なしで整数値を返す）のビットマスクの組み合わせであるため、サンプルコードのようにビット演算子（&）を使って特定の定数との一致を確認することで、「後に位置しているか」「前に位置しているか」といった詳細な位置関係を正確に判断できます。これにより、XMLツリーの構造を動的に解析し、要素の順序や親子関係を効率的に処理することが可能になります。

Copy
1<?php
2
3/**
4 * 2つのDOMノードの位置関係を比較し、
5 * 2番目のノードが1番目のノードの後に続くかどうかを判定します。
6 *
7 * DOMNode::DOCUMENT_POSITION_FOLLOWING 定数 (0x02) は、
8 * compareDocumentPosition メソッドの戻り値のビットマスクの一部として使用され、
9 * あるノードが比較の基準となるノードの「後に続く (post)」位置にあることを示します。
10 * この定数はDOM拡張機能の一部であり、PHP 8で利用可能です。
11 *
12 * @param DOMNode $nodeA 比較の基準となる1番目のノード。
13 * @param DOMNode $nodeB 比較対象となる2番目のノード。
14 * @return void 結果を標準出力に表示します。
15 */
16function compareDomNodePosition(DOMNode $nodeA, DOMNode $nodeB): void
17{
18    // compareDocumentPosition メソッドは、2つのノードの位置関係を示すビットマスクを返します。
19    // DOCUMENT_POSITION_FOLLOWING は、ノードBがノードAの後に続く場合にこのビットマスクに含まれます。
20    $position = $nodeA->compareDocumentPosition($nodeB);
21
22    echo "ノードAとノードBの位置関係の比較結果 (ビットマスク): " . $position . "\n";
23    echo "DOMNode::DOCUMENT_POSITION_FOLLOWING 定数の値: " . DOMNode::DOCUMENT_POSITION_FOLLOWING . " (0x" . dechex(DOMNode::DOCUMENT_POSITION_FOLLOWING) . ")\n";
24
25    // ビットマスクをチェックして、DOCUMENT_POSITION_FOLLOWING フラグがセットされているか確認します。
26    // フラグがセットされている場合、ノードBはノードAの後に続きます。
27    if (($position & DOMNode::DOCUMENT_POSITION_FOLLOWING) === DOMNode::DOCUMENT_POSITION_FOLLOWING) {
28        echo "結果: ノードBはノードAの**後に**続きます。\n";
29    } else {
30        echo "結果: ノードBはノードAの後に続きません。\n";
31    }
32}
33
34// サンプルDOMドキュメントの作成
35$dom = new DOMDocument();
36// XMLをロードする際に、余分な空白ノードが作成されないように設定
37$dom->preserveWhiteSpace = false;
38$dom->formatOutput = true; // 出力を整形する場合はtrue
39
40$dom->loadXML('<root><item id="first">A</item><item id="second">B</item><item id="third">C</item></root>');
41
42// XPathを使用して比較対象のノードを取得
43$xpath = new DOMXPath($dom);
44
45// 比較1: ノードBがノードAの後に続くケース
46$nodeA_1 = $xpath->query("//item[@id='first']")->item(0);
47$nodeB_1 = $xpath->query("//item[@id='second']")->item(0);
48
49if ($nodeA_1 && $nodeB_1) {
50    echo "--- 比較1: 'first' 要素と 'second' 要素 ---\n";
51    compareDomNodePosition($nodeA_1, $nodeB_1);
52} else {
53    echo "ノードの取得に失敗しました。XPathクエリを確認してください。\n";
54}
55
56echo "\n";
57
58// 比較2: ノードBがノードAの前に来るケース
59$nodeA_2 = $xpath->query("//item[@id='second']")->item(0);
60$nodeB_2 = $xpath->query("//item[@id='first']")->item(0);
61
62if ($nodeA_2 && $nodeB_2) {
63    echo "--- 比較2: 'second' 要素と 'first' 要素 (逆順) ---\n";
64    compareDomNodePosition($nodeA_2, $nodeB_2);
65} else {
66    echo "ノードの取得に失敗しました。XPathクエリを確認してください。\n";
67}
68
69echo "\n";
70
71// 比較3: 同じノードを比較するケース（DOMNode::DOCUMENT_POSITION_SAME_NODE が返される）
72$nodeA_3 = $xpath->query("//item[@id='first']")->item(0);
73$nodeB_3 = $xpath->query("//item[@id='first']")->item(0);
74
75if ($nodeA_3 && $nodeB_3) {
76    echo "--- 比較3: 'first' 要素と 'first' 要素 (同じノード) ---\n";
77    compareDomNodePosition($nodeA_3, $nodeB_3);
78} else {
79    echo "ノードの取得に失敗しました。XPathクエリを確認してください。\n";
80}

PHPのDOM拡張機能は、XMLやHTMLドキュメント内の要素（ノード）を操作するための機能を提供します。DOMNode::DOCUMENT_POSITION_FOLLOWING定数は、二つのDOMノードの位置関係を比較する際に使用される特別な値です。この定数は整数型（0x02）で、あるノードが別のノードの「後に続く」という状態をビットフラグとして表します。

サンプルコード内のcompareDomNodePosition関数は、二つのDOMノード（$nodeAと$nodeB）を引数として受け取り、$nodeBが$nodeAの後に続くかどうかを判定します。関数内部では、$nodeAのcompareDocumentPositionメソッドを呼び出し、$nodeBとの相対的な位置関係を示すビットマスク形式の整数値を取得します。この取得した値とDOMNode::DOCUMENT_POSITION_FOLLOWING定数をビット論理積（&）で比較することで、$nodeBが$nodeAの後に位置しているかを確認します。結果は標準出力に表示され、関数自体は戻り値を返しません（void）。

コードの下部では、具体的なXMLドキュメントとノードを準備し、様々なケースでcompareDomNodePosition関数を呼び出すことで、DOCUMENT_POSITION_FOLLOWING定数を利用したノードの位置関係判定の実際の挙動を学ぶことができます。