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

Copy
1<?php
2
3/**
4 * DOMノード間の位置関係を比較する例。
5 * Dom\CDATASection ノードと他のノードの関係性を
6 * DOCUMENT_POSITION_FOLLOWING と DOCUMENT_POSITION_PRECEDING 定数を使って示します。
7 */
8function demonstrateNodePositionComparison(): void
9{
10    // 1. Dom\Document インスタンスを作成
11    $dom = new Dom\Document();
12    $dom->formatOutput = true; // 出力されるXMLを見やすく整形
13
14    // 2. ルート要素 'root' を作成し、ドキュメントに追加
15    $rootElement = $dom->createElement('root');
16    $dom->appendChild($rootElement);
17
18    // 3. 最初の要素 'first' を作成し、ルート要素の子として追加
19    $firstElement = $dom->createElement('first');
20    $rootElement->appendChild($firstElement);
21
22    // 4. Dom\CDATASection ノードを作成し、'first' 要素の子として追加
23    //    これが比較の対象となるノードの一つです。
24    $cdataNode = $dom->createCDATASection('This is a CDATA section content.');
25    $firstElement->appendChild($cdataNode);
26
27    // 5. 2番目の要素 'second' を作成し、ルート要素の子として追加
28    //    これは Dom\CDATASection ノードの「後」に位置します。
29    $secondElement = $dom->createElement('second');
30    $rootElement->appendChild($secondElement);
31
32    // 現在のDOM構造を出力して確認
33    echo "--- Current DOM Structure ---\n";
34    echo $dom->saveXML() . "\n";
35    echo "-----------------------------\n\n";
36
37    echo "--- Node Position Comparison Results ---\n";
38
39    // 6. $cdataNode ($firstElement の子) と $secondElement の位置を比較します。
40    //    $cdataNode は $secondElement よりも前にあります。
41    echo "Comparing CDATASection node with 'second' element:\n";
42    $positionOfCdataToSecond = $cdataNode->compareDocumentPosition($secondElement);
43
44    // DOCUMENT_POSITION_FOLLOWING は、比較対象ノードが参照ノードの後にあることを示します。
45    // ここでは $cdataNode から $secondElement を見ているので、$cdataNode が $secondElement の前にあれば、
46    // $secondElement は $cdataNode の後に位置することになり、このフラグが立ちます。
47    if ($positionOfCdataToSecond & Dom\Node::DOCUMENT_POSITION_FOLLOWING) {
48        echo "  - CDATASection node is FOLLOWED BY 'second' element (i.e., 'second' element comes AFTER CDATASection node).\n";
49    }
50
51    // DOCUMENT_POSITION_PRECEDING は、比較対象ノードが参照ノードの前にあることを示します。
52    // ここでは $cdataNode から $secondElement を見ているので、$cdataNode が $secondElement の前にあっても、
53    // これは $cdataNode が $secondElement を先導していることを意味しません。
54    // むしろ、'second' 要素が CDATASection ノードの後に続くことを意味します。
55    // $cdataNode は $secondElement の前に位置するので、このフラグは立ちません。
56    if ($positionOfCdataToSecond & Dom\Node::DOCUMENT_POSITION_PRECEDING) {
57        echo "  - CDATASection node PRECEDES 'second' element (i.e., 'second' element comes BEFORE CDATASection node).\n";
58    }
59
60
61    echo "\nComparing 'second' element with CDATASection node:\n";
62    // 7. 逆の比較：$secondElement から $cdataNode ($firstElement の子) の位置を比較します。
63    //    $secondElement は $cdataNode よりも後にあります。
64    $positionOfSecondToCdata = $secondElement->compareDocumentPosition($cdataNode);
65
66    // DOCUMENT_POSITION_FOLLOWING は、$secondElement が $cdataNode の後に位置することを示します。
67    // この場合、$secondElement は $cdataNode の後に作成されたため、このフラグが立ちます。
68    if ($positionOfSecondToCdata & Dom\Node::DOCUMENT_POSITION_FOLLOWING) {
69        echo "  - 'second' element FOLLOWS CDATASection node.\n";
70    }
71
72    // DOCUMENT_POSITION_PRECEDING は、$secondElement が $cdataNode の前に位置することを示します。
73    // この場合、$secondElement は $cdataNode の後に作成されたため、このフラグは立ちません。
74    if ($positionOfSecondToCdata & Dom\Node::DOCUMENT_POSITION_PRECEDING) {
75        echo "  - 'second' element PRECEDES CDATASection node.\n";
76    }
77
78    echo "--------------------------------------\n";
79}
80
81// 関数を実行して結果を表示
82demonstrateNodePositionComparison();

PHPのDOM（Document Object Model）操作において、ドキュメント内のノード間の位置関係を比較する方法を示すサンプルコードです。特に、Dom\NodeクラスのcompareDocumentPositionメソッドを使用し、Dom\CDATASectionノードを含む異なるノードがXMLドキュメント内でどのような順序で配置されているかを確認します。

Dom\Node::DOCUMENT_POSITION_FOLLOWING定数は、比較対象のノードが基準となるノードの「後」に位置する場合に、compareDocumentPositionメソッドの戻り値に含まれるビットフラグです。これは整数値として定義されており、引数はありません。一方、Dom\Node::DOCUMENT_POSITION_PRECEDING定数は、比較対象のノードが基準となるノードの「前」に位置する場合に設定されるビットフラグです。

このサンプルコードでは、まずDom\Documentオブジェクトを作成し、複数の要素とDom\CDATASectionノードを追加してDOMツリーを構築します。次に、作成した$cdataNodeと$secondElementのノードを取り上げ、お互いの位置をcompareDocumentPositionメソッドで比較しています。このメソッドは引数として比較対象のDom\Nodeを受け取り、比較結果を示す整数値を返します。返された整数値をビット演算子&とこれらの定数で確認することで、「$secondElementは$cdataNodeの後に存在する」といった具体的な位置関係を正確に判別できます。これは、XML構造の解析や特定のノードを探す際に非常に役立つ機能です。

Copy
1<?php
2
3/**
4 * 指定された2つのDOMノードの相対的な位置関係を比較します。
5 * 特に、最初のノードが2番目のノードに後続するかどうかをチェックし、
6 * 結果を標準出力に出力します。
7 *
8 * `Dom\CDATASection::DOCUMENT_POSITION_FOLLOWING` 定数は、
9 * `Dom\Node::compareDocumentPosition` メソッドによって返されるビットマスクの一部であり、
10 * 最初のノードが文書ツリー内で2番目のノードの後ろに位置する場合に設定されます。
11 *
12 * @param Dom\Node $node1 比較する最初のノード。`Dom\CDATASection`も`Dom\Node`を継承しています。
13 * @param Dom\Node $node2 比較する2番目のノード。
14 * @return void 結果をコンソールに出力します。
15 */
16function compareNodePositions(Dom\Node $node1, Dom\Node $node2): void
17{
18    // compareDocumentPosition メソッドは、2つのノード間の相対的な位置関係を示すビットマスクを返します。
19    $position = $node1->compareDocumentPosition($node2);
20
21    echo "ノード1 ({$node1->nodeName}) とノード2 ({$node2->nodeName}) の位置比較:\n";
22
23    // Dom\CDATASection::DOCUMENT_POSITION_FOLLOWING 定数を使用して、
24    // 最初のノードが2番目のノードに後続しているか（文書ツリー内で後ろに位置するか）を判定します。
25    if (($position & Dom\CDATASection::DOCUMENT_POSITION_FOLLOWING) === Dom\CDATASection::DOCUMENT_POSITION_FOLLOWING) {
26        echo "  - ノード1はノード2に後続しています (文書ツリー内でノード2の後ろに位置します)。\n";
27    } else {
28        echo "  - ノード1はノード2に後続していません。\n";
29    }
30
31    // その他の主要な位置関係も表示し、DOMノードの位置比較の理解を深めます。
32    // これらの定数は Dom\Node にも定義されており、比較結果のビットマスクと論理積をとることで確認できます。
33    if (($position & Dom\Node::DOCUMENT_POSITION_PRECEDING) === Dom\Node::DOCUMENT_POSITION_PRECEDING) {
34        echo "  - ノード1はノード2に先行しています。\n";
35    }
36    if (($position & Dom\Node::DOCUMENT_POSITION_CONTAINS) === Dom\Node::DOCUMENT_POSITION_CONTAINS) {
37        echo "  - ノード1はノード2を含んでいます。\n";
38    }
39    if (($position & Dom\Node::DOCUMENT_POSITION_CONTAINED_BY) === Dom\Node::DOCUMENT_POSITION_CONTAINED_BY) {
40        echo "  - ノード1はノード2に含まれています。\n";
41    }
42    if (($position & Dom\Node::DOCUMENT_POSITION_DISCONNECTED) === Dom\Node::DOCUMENT_POSITION_DISCONNECTED) {
43        echo "  - ノード1とノード2は異なるツリーにあります。\n";
44    }
45    if (($position & Dom\Node::DOCUMENT_POSITION_SAME_NODE) === Dom\Node::DOCUMENT_POSITION_SAME_NODE) {
46        echo "  - ノード1とノード2は同じノードです。\n";
47    }
48    echo "\n";
49}
50
51// -------------------------------------------------------------------
52// サンプルDOMツリーの構築とノード比較の実行
53// -------------------------------------------------------------------
54
55// DOMドキュメントを作成 (PHP 8の新しいDom名前空間を使用)
56$dom = new Dom\Document('1.0', 'UTF-8');
57$dom->formatOutput = true; // 出力を見やすく整形
58
59// ルート要素を作成し、ドキュメントに追加
60$root = $dom->createElement('root');
61$dom->appendChild($root);
62
63// 子要素とDom\CDATASectionを作成し、ルート要素に追加
64$elementA = $dom->createElement('elementA', 'テキストA');
65$root->appendChild($elementA);
66
67// Dom\CDATASection クラスのインスタンスを作成し、DOMツリーに追加
68// Dom\CDATASection は Dom\Node を継承しており、比較対象として使用できます。
69$cdataSection = $dom->createCDATASection('これはCDATAセクションです。特別な文字も含まれます: <>&');
70$root->appendChild($cdataSection); // elementA の後に CDATAセクション を追加
71
72$elementB = $dom->createElement('elementB', 'テキストB');
73$root->appendChild($elementB); // CDATAセクション の後に elementB を追加
74
75$elementC = $dom->createElement('elementC');
76$elementB->appendChild($elementC); // elementB の子要素として elementC を追加
77
78// -------------------------------------------------------------
79// ノード位置比較の実行例
80// -------------------------------------------------------------
81
82echo "--- 比較例 1: elementA と cdataSection ---\n";
83// elementA は cdataSection より文書ツリー内で前に位置します
84compareNodePositions($elementA, $cdataSection);
85
86echo "--- 比較例 2: cdataSection と elementA ---\n";
87// cdataSection は elementA より文書ツリー内で後に位置します (DOCUMENT_POSITION_FOLLOWING)
88compareNodePositions($cdataSection, $elementA);
89
90echo "--- 比較例 3: cdataSection と elementB ---\n";
91// cdataSection は elementB より文書ツリー内で前に位置します
92compareNodePositions($cdataSection, $elementB);
93
94echo "--- 比較例 4: elementB と cdataSection ---\n";
95// elementB は cdataSection より文書ツリー内で後に位置します (DOCUMENT_POSITION_FOLLOWING)
96compareNodePositions($elementB, $cdataSection);
97
98echo "--- 比較例 5: elementB と elementC (親ノードと子ノード) ---\n";
99// elementB は elementC を含んでいます (DOCUMENT_POSITION_CONTAINS)
100compareNodePositions($elementB, $elementC);
101
102echo "--- 比較例 6: elementC と elementB (子ノードと親ノード) ---\n";
103// elementC は elementB に含まれています (DOCUMENT_POSITION_CONTAINED_BY)
104compareNodePositions($elementC, $elementB);
105
106echo "--- 比較例 7: 同じノードの比較 ---\n";
107// elementA と elementA は同じノードです (DOCUMENT_POSITION_SAME_NODE)
108compareNodePositions($elementA, $elementA);
109
110// ドキュメントツリーに追加されていないノード
111$disconnectedElement = $dom->createElement('disconnected');
112echo "--- 比較例 8: 接続されていないノードとの比較 ---\n";
113// elementA と disconnectedElement は異なるツリーにあります (DOCUMENT_POSITION_DISCONNECTED)
114compareNodePositions($elementA, $disconnectedElement);
115
116?>

このPHPコードは、XMLやHTMLなどのDOMツリーにおいて、2つのDOMノードがどのような位置関係にあるかを比較する方法を示しています。特に、Dom\CDATASection::DOCUMENT_POSITION_FOLLOWING定数を使用して、最初のノードが2番目のノードよりも文書ツリーの後方（後続）に位置するかどうかを判定します。この定数は整数（int）として定義されており、比較メソッドの結果に含まれるビットマスクの一部として機能します。

コードの中心となるcompareNodePositions関数は、比較対象となる2つのDOMノードをDom\Node型の引数$node1と$node2として受け取ります。Dom\CDATASectionのような特定のノードもDom\Nodeを継承しているため、これらの引数として渡すことが可能です。この関数は特定の値を返さず（void）、比較結果を直接コンソールに出力する役割を担います。

関数内部では、$node1->compareDocumentPosition($node2)メソッドが実行され、このメソッドは2つのノード間の相対的な位置関係を示す整数値のビットマスクを返します。このビットマスクとDom\CDATASection::DOCUMENT_POSITION_FOLLOWING定数を論理積（&）で比較することで、最初のノードが2番目のノードに後続しているかを正確に判断しています。この他にも、先行、包含、被包含、非接続など、主要な他の位置関係も同時に表示し、DOMノード間の関係性に関する理解を深めることができます。コードの後半では、具体的なDOMツリーを構築し、複数のノードの組み合わせでcompareNodePositions関数を実行する例が示されており、定数とメソッドの動作が明確に確認できます。