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

Copy
1<?php
2
3/**
4 * DOMノード間の位置関係を比較し、Dom\DocumentType::DOCUMENT_POSITION_FOLLOWING
5 * およびキーワードであるDOCUMENT_POSITION_PRECEDINGの動作を示すサンプルコードです。
6 *
7 * DOMNode::compareDocumentPosition メソッドは、2つのノード間の相対的な位置関係を
8 * ビットマスクとして返します。これらのビットは論理AND演算子 (&) を用いて評価されます。
9 */
10function demonstrateNodePositionComparison(): void
11{
12    // 新しいDOMドキュメントを作成
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    $dom->formatOutput = true; // 整形して出力
15
16    // 要素を作成し、ドキュメントツリーに追加
17    $root = $dom->createElement('root');
18    $dom->appendChild($root);
19
20    $child1 = $dom->createElement('child1');
21    $root->appendChild($child1);
22
23    $grandchild = $dom->createElement('grandchild');
24    $child1->appendChild($grandchild);
25
26    $child2 = $dom->createElement('child2');
27    $root->appendChild($child2);
28
29    echo "--- ドキュメント構造 ---\n";
30    echo $dom->saveXML() . "\n";
31
32    echo "--- ノード位置の比較結果 ---\n";
33
34    // ケース1: child1 と child2 の比較
35    // child2 は child1 の「後に続く」位置にあります。
36    echo "1. child1 と child2 の比較:\n";
37    $positionFlags = $child1->compareDocumentPosition($child2);
38
39    // Dom\DocumentType::DOCUMENT_POSITION_FOLLOWING は、比較対象ノードが参照ノードに続いて現れることを示します。
40    if ($positionFlags & Dom\DocumentType::DOCUMENT_POSITION_FOLLOWING) {
41        echo "  - child2 は child1 の後にあります。\n";
42    }
43    // Dom\DocumentType::DOCUMENT_POSITION_PRECEDING は、比較対象ノードが参照ノードの前に現れることを示します。
44    if ($positionFlags & Dom\DocumentType::DOCUMENT_POSITION_PRECEDING) {
45        echo "  - child2 は child1 の前にあります。(このケースでは表示されません)\n";
46    }
47    echo "\n";
48
49    // ケース2: child2 と child1 の比較
50    // child1 は child2 の「前に位置する」位置にあります。(キーワード: document_position_preceding)
51    echo "2. child2 と child1 の比較:\n";
52    $positionFlags = $child2->compareDocumentPosition($child1);
53
54    if ($positionFlags & Dom\DocumentType::DOCUMENT_POSITION_FOLLOWING) {
55        echo "  - child1 は child2 の後にあります。(このケースでは表示されません)\n";
56    }
57    if ($positionFlags & Dom\DocumentType::DOCUMENT_POSITION_PRECEDING) {
58        echo "  - child1 は child2 の前にあります。\n";
59    }
60    echo "\n";
61
62    // ケース3: root と child1 の比較 (包含関係の例)
63    // child1 は root に「含まれる」位置にあります。
64    echo "3. root と child1 の比較:\n";
65    $positionFlags = $root->compareDocumentPosition($child1);
66
67    if ($positionFlags & Dom\DocumentType::DOCUMENT_POSITION_CONTAINS) {
68        echo "  - root は child1 を含んでいます。\n";
69    }
70    if ($positionFlags & Dom\DocumentType::DOCUMENT_POSITION_CONTAINED_BY) {
71        echo "  - child1 は root に含まれています。(このケースでは表示されません)\n";
72    }
73    echo "\n";
74
75    // 参考: 同じノードの比較
76    echo "4. child1 と child1 の比較:\n";
77    $positionFlags = $child1->compareDocumentPosition($child1);
78    if ($positionFlags === 0) { // 0 はノードが同じであることを示します
79        echo "  - ノードは同じです。\n";
80    }
81    echo "\n";
82}
83
84// 関数を実行して、ノード位置比較のデモンストレーションを行います。
85demonstrateNodePositionComparison();

このPHPサンプルコードは、DOM（Document Object Model）ツリーにおける複数のノードが互いにどのような相対的な位置関係にあるかをプログラムで判断する方法を示しています。

Dom\DocumentType::DOCUMENT_POSITION_FOLLOWINGは、DOMツリーにおけるノード間の相対的な位置関係を表す定数の一つで、引数はなく、整数値（int）を返します。この定数は、主にDOMNode::compareDocumentPositionメソッドが返すビットマスク（複数の状態を表現する整数値）と論理AND演算子（&）を用いて比較することで、特定の位置関係にあるかを判定するために利用されます。

具体的には、DOCUMENT_POSITION_FOLLOWING定数は、比較対象のノードが基準となるノードの「後に続く」場合に、compareDocumentPositionメソッドの戻り値に含まれるフラグを示します。対照的に、キーワードであるDOCUMENT_POSITION_PRECEDING定数は、比較対象のノードが基準ノードの「前に位置する」場合に示されるフラグです。

サンプルコードでは、child1ノードとchild2ノードを比較し、child2がchild1の後に続くこと（DOCUMENT_POSITION_FOLLOWING）や、逆にchild1がchild2の前に位置すること（DOCUMENT_POSITION_PRECEDING）を確認しています。また、親ノードが子ノードを包含する関係（DOCUMENT_POSITION_CONTAINS）の判定例も含まれています。これらの定数を利用することで、DOMツリーの構造をプログラムで正確に解析し、ノードの配置に応じた複雑な処理を実装することが可能になります。

Copy
1<?php
2
3/**
4 * 2つのDOMノードを比較し、$nodeB が $nodeA のドキュメント順で後に続くかどうかを判定します。
5 *
6 * この関数は、DOMNode::compareDocumentPosition メソッドと、
7 * Dom\DocumentType::DOCUMENT_POSITION_FOLLOWING 定数を使用して位置関係を評価します。
8 * DOCUMENT_POSITION_FOLLOWING は、比較対象のノードが基準ノードの後に続くことを示すビットマスクです。
9 *
10 * @param \DOMNode $nodeA 比較の基準となる最初のDOMノード。
11 * @param \DOMNode $nodeB 比較対象の2番目のDOMノード。このノードが $nodeA の後に続くかを判定します。
12 * @return bool $nodeB が $nodeA のドキュメント順で後に続く場合にtrue、それ以外はfalse。
13 */
14function isNodeFollowing(\DOMNode $nodeA, \DOMNode $nodeB): bool
15{
16    // compareDocumentPosition メソッドは、2つのノード間の関係を示すビットマスクを返します。
17    // このビットマスクを Dom\DocumentType::DOCUMENT_POSITION_FOLLOWING 定数と比較します。
18    // ビットAND演算子 (&) を使用して、DOCUMENT_POSITION_FOLLOWING フラグが結果に含まれているかを確認します。
19    $position = $nodeA->compareDocumentPosition($nodeB);
20
21    // Dom\DocumentType::DOCUMENT_POSITION_FOLLOWING は、PHP 8で追加された定数です。
22    // この定数は、DOM_DOCUMENT_POSITION_FOLLOWING と同じ値を持ちます。
23    return ($position & \Dom\DocumentType::DOCUMENT_POSITION_FOLLOWING) > 0;
24}
25
26// --- 以下はサンプルコードの実行例です ---
27
28// 新しいDOMドキュメントを作成
29$dom = new \DOMDocument('1.0', 'UTF-8');
30$dom->loadXML(
31    <<<XML
32<root>
33    <elementA>
34        <childA id="1"/>
35    </elementA>
36    <elementB id="2"/>
37    <elementC id="3"/>
38</root>
39XML
40);
41
42// 比較対象となるDOMノードを取得します
43$elementA = $dom->getElementsByTagName('elementA')->item(0);
44$elementB = $dom->getElementsByTagName('elementB')->item(0);
45$elementC = $dom->getElementsByTagName('elementC')->item(0);
46$childA = $dom->getElementsByTagName('childA')->item(0);
47$root = $dom->documentElement;
48
49echo "DOMノードの位置関係の判定:\n";
50
51// elementB は elementA の後に続くか？
52// (XML構造: <elementA>...</elementA><elementB/>)
53if (isNodeFollowing($elementA, $elementB)) {
54    echo " - 'elementB' は 'elementA' の後に続きます。\n"; // 結果: true
55} else {
56    echo " - 'elementB' は 'elementA' の後に続きません。\n";
57}
58
59// childA は elementA の後に続くか？
60// (XML構造: <elementA><childA/></elementA>)
61// childA は elementA の子孫であり、その後に続くわけではないためfalse
62if (isNodeFollowing($elementA, $childA)) {
63    echo " - 'childA' は 'elementA' の後に続きます。\n";
64} else {
65    echo " - 'childA' は 'elementA' の後に続きません。(子孫関係です)\n"; // 結果: false
66}
67
68// elementA は elementB の後に続くか？ (順番が逆のためfalse)
69if (isNodeFollowing($elementB, $elementA)) {
70    echo " - 'elementA' は 'elementB' の後に続きます。\n";
71} else {
72    echo " - 'elementA' は 'elementB' の後に続きません。\n"; // 結果: false
73}
74
75// elementC は root の後に続くか？ (rootの子孫であり、後に続くわけではないためfalse)
76if (isNodeFollowing($root, $elementC)) {
77    echo " - 'elementC' は 'root' の後に続きます。\n";
78} else {
79    echo " - 'elementC' は 'root' の後に続きません。(子孫関係です)\n"; // 結果: false
80}

このPHPサンプルコードは、DOMツリー上の2つのノードがドキュメント順でどのような位置にあるかを判定する方法を示します。isNodeFollowing関数は、比較の基準となるDOMノード$nodeAと、その後に続くかを判定するDOMノード$nodeBを引数に受け取ります。そして、$nodeBが$nodeAの後に続く場合にtrueを、それ以外はfalseをブール値で返します。

この判定には、DOMNode::compareDocumentPositionメソッドと、PHP 8で導入されたDom\DocumentType::DOCUMENT_POSITION_FOLLOWING定数を使用します。compareDocumentPositionメソッドは2つのノード間の関係を示すビットマスクを返しますが、DOCUMENT_POSITION_FOLLOWING定数は、そのビットマスク内で「比較対象ノードが基準ノードの後に続く」ことを示す特定の値です。関数内では、ビットAND演算子を用いてこの定数がメソッドの戻り値に含まれるかを確認し、ノードの順序関係を正確に判断しています。

サンプルコードの実行例では、具体的なXML構造から取得した複数のノードに対しisNodeFollowing関数を適用し、その挙動を確認しています。この例から、兄弟関係のノードは「後に続く」と判定される一方、親子関係（子孫ノード）のノードは「後に続く」とは判定されないという、DOMにおける位置関係の具体的な定義が理解できます。このような機能は、DOM内のノードの物理的な配置に基づいた処理を行う際に役立ちます。