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

Copy
1<?php
2
3/**
4 * DOMノード間の位置関係を比較するサンプルコードです。
5 * DOMNode::compareDocumentPosition メソッドと関連する定数
6 * DOMNode::DOCUMENT_POSITION_FOLLOWING および DOMNode::DOCUMENT_POSITION_PRECEDING を使用します。
7 * システムエンジニアを目指す初心者向けに、DOM要素と属性ノード間の比較を示します。
8 */
9function compareDomNodePositions(): void
10{
11    // 1. DOMDocumentを作成し、サンプルXMLをロードします。
12    //    簡単なXML構造を用意し、比較対象となる要素と属性を含めます。
13    $dom = new DOMDocument();
14    $dom->loadXML('<root><elementA id="first" /><elementB id="second" data-attr="example" /></root>');
15
16    // 2. 比較するノードを取得します。
17    //    - 最初の要素ノード (elementA)
18    //    - 2番目の要素ノード (elementB) に含まれる属性ノード (data-attr)
19    //    リファレンス情報にあるDOMAttrに関連するため、属性ノードを比較対象に含めます。
20
21    $elementA = $dom->getElementsByTagName('elementA')->item(0);
22    if (!$elementA) {
23        echo "エラー: 'elementA' 要素が見つかりません。\n";
24        return;
25    }
26
27    $elementB = $dom->getElementsByTagName('elementB')->item(0);
28    if (!$elementB) {
29        echo "エラー: 'elementB' 要素が見つかりません。\n";
30        return;
31    }
32
33    // elementB の 'data-attr' 属性ノードを取得します。
34    // DOMAttr クラスのインスタンスとして扱われます。
35    $attributeNode = $elementB->getAttributeNode('data-attr');
36    if (!$attributeNode) {
37        echo "エラー: 'data-attr' 属性ノードが見つかりません。\n";
38        return;
39    }
40
41    echo "--- ノード間の位置比較 --- \n\n";
42
43    // 3. ノード A (elementA) からノード B (attributeNode) の位置を比較します。
44    //    compareDocumentPosition は、呼び出し元のノード(elementA)から見て、
45    //    引数で渡されたノード(attributeNode)がどこにあるかをビットマスクで返します。
46    //    elementA は attributeNode の "前" にあります。
47    $positionFromA = $elementA->compareDocumentPosition($attributeNode);
48
49    echo "比較対象1:\n";
50    echo "  参照ノード: <elementA id=\"first\">\n";
51    echo "  比較ノード: data-attr=\"example\" 属性ノード (親: <elementB id=\"second\">)\n";
52    echo "結果のビットマスク値: " . $positionFromA . "\n";
53
54    // DOMNode::DOCUMENT_POSITION_FOLLOWING: 比較ノードが参照ノードの「後」にあることを示します。
55    // ビット演算子 '&' を使用して、結果のビットマスクに特定の定数が含まれているかを確認します。
56    if (($positionFromA & DOMNode::DOCUMENT_POSITION_FOLLOWING) === DOMNode::DOCUMENT_POSITION_FOLLOWING) {
57        echo "  -> 属性ノードは、<elementA> の「後」にあります (DOCUMENT_POSITION_FOLLOWING)。\n";
58    }
59
60    echo "\n--------------------------\n\n";
61
62    // 4. ノード A (attributeNode) からノード B (elementA) の位置を比較します。
63    //    今回は参照ノードと比較ノードを入れ替えます。
64    //    attributeNode は elementA の "後" にあります。
65    $positionFromAttr = $attributeNode->compareDocumentPosition($elementA);
66
67    echo "比較対象2:\n";
68    echo "  参照ノード: data-attr=\"example\" 属性ノード (親: <elementB id=\"second\">)\n";
69    echo "  比較ノード: <elementA id=\"first\">\n";
70    echo "結果のビットマスク値: " . $positionFromAttr . "\n";
71
72    // DOMNode::DOCUMENT_POSITION_PRECEDING: 比較ノードが参照ノードの「前」にあることを示します。
73    // キーワードとして指定された定数です。
74    if (($positionFromAttr & DOMNode::DOCUMENT_POSITION_PRECEDING) === DOMNode::DOCUMENT_POSITION_PRECEDING) {
75        echo "  -> <elementA> は、属性ノードの「前」にあります (DOCUMENT_POSITION_PRECEDING)。\n";
76    }
77
78    // その他、DOMNode::DOCUMENT_POSITION_DISCONNECTED なども存在しますが、
79    // 基本的な位置関係の比較として上記が重要です。
80}
81
82// 関数を実行して、DOMノードの位置関係の比較結果を確認します。
83compareDomNodePositions();

このPHPサンプルコードは、DOM（Document Object Model）におけるノード間の位置関係を比較する方法を示しています。主にDOMNodeクラスのcompareDocumentPositionメソッドと、その結果を解釈するための定数であるDOCUMENT_POSITION_FOLLOWINGおよびDOCUMENT_POSITION_PRECEDINGを使用します。compareDocumentPositionメソッドは、呼び出し元のノード（参照ノード）から見て、引数として渡されたノード（比較ノード）がDOMツリー内のどこに位置するかを、整数値のビットマスクとして返します。リファレンス情報にあるDOCUMENT_POSITION_FOLLOWINGは、比較ノードが参照ノードの「後」にあることを示す定数です。同様にDOCUMENT_POSITION_PRECEDINGは、比較ノードが参照ノードの「前」にあることを示す定数です。このサンプルでは、まず簡単なXMLドキュメントを作成し、そこから特定の要素ノードと属性ノードを取得します。属性ノードはDOMAttrクラスのインスタンスとして扱われます。これらのノードを相互に比較することで、どちらがDOMツリー上で先に現れるか、あるいは後に現れるかを判断しています。結果のビットマスク値とこれらの定数をビット演算子（&）で組み合わせることで、詳細な位置関係を正確に判定し、出力しています。この理解は、複雑なXMLやHTMLドキュメントをPHPで操作する上で重要な基礎知識となります。

Copy
1<?php
2
3/**
4 * 二つのDOMノード間の位置関係を比較し、一方のノードがもう一方のノードの後に続くかを判定します。
5 *
6 * この関数は、DOMNode::compareDocumentPosition() メソッドを使用し、
7 * その結果に DOMNode::DOCUMENT_POSITION_FOLLOWING (または DOMAttr::DOCUMENT_POSITION_FOLLOWING)
8 * のフラグが含まれているかを確認します。
9 *
10 * @param DOMNode $node1 比較の基準となる最初のノード。
11 * @param DOMNode $node2 比較対象の2番目のノード。$node1 の後に続くかを判定します。
12 * @return bool $node2 が $node1 のDOMツリー内で「後に続く」位置にある場合にtrueを返します。
13 */
14function isNodeFollowing(DOMNode $node1, DOMNode $node2): bool
15{
16    // DOMNode::compareDocumentPosition() は、二つのノード間の相対的な位置関係を
17    // ビットマスクとして返します。
18    // DOMAttr::DOCUMENT_POSITION_FOLLOWING は、このビットマスクの一つで、
19    // 比較対象のノードが基準ノードの後に続くことを示します。
20    // この定数は DOMNode クラスにも同じ値で定義されています。
21    $positionResult = $node1->compareDocumentPosition($node2);
22
23    // ビットAND演算子 (&) を使用して、DOCUMENT_POSITION_FOLLOWING のフラグが
24    // 結果に含まれているかを確認します。
25    // 例えば、DOMAttr::DOCUMENT_POSITION_FOLLOWING の値は 4 です。
26    return (bool)($positionResult & DOMNode::DOCUMENT_POSITION_FOLLOWING);
27}
28
29// --- 単体で動作可能なサンプルコード ---
30
31// 1. DOMDocumentインスタンスを作成
32$dom = new DOMDocument();
33
34// 2. ルート要素を作成し、DOMツリーに追加
35$rootElement = $dom->createElement('root');
36$dom->appendChild($rootElement);
37
38// 3. 複数の子要素を作成し、ルート要素に追加
39$childElement1 = $dom->createElement('child1');
40$rootElement->appendChild($childElement1);
41
42$childElement2 = $dom->createElement('child2');
43$rootElement->appendChild($childElement2);
44
45// 4. 属性ノードを作成 (DOMAttr オブジェクト)
46// DOMAttr は DOMNode を継承しています。
47$attributeNode = $dom->createAttribute('data-value');
48$attributeNode->value = 'sample';
49$childElement1->appendChild($attributeNode); // 属性は要素の属性リストに追加される
50
51echo "=== DOMノード間の位置関係判定 ===\n";
52
53// 例1: 基準ノード(rootElement)の後に子ノード(childElement1)が続くか
54// 結果: Yes (DOMツリー構造上、子要素は親要素の後に続くと見なされます)
55echo "Is 'child1' following 'root'? " . (isNodeFollowing($rootElement, $childElement1) ? 'Yes' : 'No') . "\n";
56
57// 例2: 基準ノード(childElement1)の後に別の兄弟ノード(childElement2)が続くか
58// 結果: Yes (childElement2はchildElement1の後に兄弟として配置されています)
59echo "Is 'child2' following 'child1'? " . (isNodeFollowing($childElement1, $childElement2) ? 'Yes' : 'No') . "\n";
60
61// 例3: 逆順の比較: 基準ノード(childElement2)の後にchildElement1が続くか
62// 結果: No (childElement1はchildElement2の前にあります)
63echo "Is 'child1' following 'child2'? " . (isNodeFollowing($childElement2, $childElement1) ? 'Yes' : 'No') . "\n";
64
65// 例4: 要素ノード(childElement1)の後に属性ノード(attributeNode)が続くか
66// 属性ノードは要素の子ノードリストではなく、属性リストに属するため、
67// 一般的なDOMツリーの走査において「後に続く」関係にはなりにくいです。
68// 結果: No (属性は要素に含まれるものとして扱われ、「後に続く」とは見なされません)
69echo "Is 'data-value' attribute following 'child1' element? " . (isNodeFollowing($childElement1, $attributeNode) ? 'Yes' : 'No') . "\n";
70
71?>

サンプルコードは、DOMツリー上の二つのノードがどのような位置関係にあるかを判断するisNodeFollowing関数を定義し、その使い方を示しています。この関数は、第一引数で指定された基準ノードの後に、第二引数で指定された比較対象ノードが続く位置にあるかを判定するために利用されます。

isNodeFollowing関数は、引数としてDOMNode型の$node1（基準ノード）と$node2（比較対象ノード）を受け取ります。関数内部では、$node1のcompareDocumentPosition()メソッドを呼び出し、$node2との相対的な位置関係を示す整数値を取得します。この整数値は、複数の位置情報を示すビットマスクとして構成されています。

ここで、DOMAttr::DOCUMENT_POSITION_FOLLOWINGという定数が重要になります。この定数は、比較対象ノードが基準ノードの「後に続く」場合にセットされるビットフラグの一つで、DOMNodeクラスにも同じ値で定義されています。取得した整数値とこの定数に対してビットAND演算を行うことで、結果の中に「後に続く」という関係が含まれているかを確認します。関数は、この関係が検出された場合にtrueを、そうでなければfalseをブール値として返します。

単体で動作するサンプルでは、DOMDocumentを作成し、様々なノード（ルート要素、子要素、属性ノード）を配置して、それらのノードペアに対してisNodeFollowing関数を適用しています。例えば、親要素の後に子要素が続く場合や、ある兄弟要素の後に別の兄弟要素が続く場合にtrueが返されることが示されています。また、要素ノードと属性ノードの比較では、属性が要素の属性リストに属するため、DOMツリー上での「後に続く」関係とは見なされず、falseが返されることも確認できます。