【PHP8.x】Dom\Attr::DOCUMENT_POSITION_CONTAINS定数の使い方

Copy
1<?php
2
3// PHP 8以降で推奨されるDom名前空間のクラスを使用します。
4use Dom\Document;
5use Dom\Node; // DOCUMENT_POSITION_CONTAINS 定数は Dom\Node クラスに属します。
6
7/**
8 * DOMノード間の包含関係を比較し、Dom\Node::DOCUMENT_POSITION_CONTAINS定数の使用例を示します。
9 * システムエンジニアを目指す初心者向けに、Domオブジェクト操作の基礎を分かりやすく解説します。
10 */
11function demonstrateDomContainsPosition(): void
12{
13    // 新しいDomドキュメントを作成します。
14    $dom = new Document();
15    // 整形されたXML出力のためにformatOutputをtrueに設定します。
16    // これはデバッグ時やXMLの可読性を向上させたい場合に便利です。
17    $dom->formatOutput = true;
18
19    // ルート要素（<root>）を作成し、ドキュメントに追加します。
20    $rootElement = $dom->createElement('root');
21    $dom->appendChild($rootElement);
22
23    // 子要素（<child>）を作成し、ルート要素に追加します。
24    $childElement = $dom->createElement('child');
25    $rootElement->appendChild($childElement);
26
27    // 孫要素（<grandchild>）を作成し、子要素に追加します。
28    $grandchildElement = $dom->createElement('grandchild');
29    $childElement->appendChild($grandchildElement);
30
31    echo "--- ノード間の包含関係の比較 ---\n";
32
33    // 1. rootElement が childElement を含んでいるか？
34    // compareDocumentPositionは、参照ノードと比較対象ノードの位置関係を示すビットマスクを返します。
35    // Dom\Node::DOCUMENT_POSITION_CONTAINS は、参照ノードが比較対象ノードを含んでいる場合に結果に含まれる定数です。
36    // ビットAND演算子 (&) を使用して、特定の定数が結果に含まれているかを確認します。
37    $positionRootToChild = $rootElement->compareDocumentPosition($childElement);
38
39    if (($positionRootToChild & Node::DOCUMENT_POSITION_CONTAINS) === Node::DOCUMENT_POSITION_CONTAINS) {
40        echo "✓ 'root' 要素は 'child' 要素を含んでいます。\n";
41    } else {
42        echo "✗ 'root' 要素は 'child' 要素を含んでいません。\n";
43    }
44
45    // 2. childElement が rootElement を含んでいるか？ (親ノードなので含んでいません)
46    $positionChildToRoot = $childElement->compareDocumentPosition($rootElement);
47    if (($positionChildToRoot & Node::DOCUMENT_POSITION_CONTAINS) === Node::DOCUMENT_POSITION_CONTAINS) {
48        echo "✗ 'child' 要素は 'root' 要素を含んでいます。\n";
49    } else {
50        echo "✓ 'child' 要素は 'root' 要素を含んでいません。\n";
51    }
52
53    // 3. childElement が grandchildElement を含んでいるか？
54    $positionChildToGrandchild = $childElement->compareDocumentPosition($grandchildElement);
55    if (($positionChildToGrandchild & Node::DOCUMENT_POSITION_CONTAINS) === Node::DOCUMENT_POSITION_CONTAINS) {
56        echo "✓ 'child' 要素は 'grandchild' 要素を含んでいます。\n";
57    } else {
58        echo "✗ 'child' 要素は 'grandchild' 要素を含んでいません。\n";
59    }
60
61    // 4. grandchildElement が childElement を含んでいるか？ (親ノードなので含んでいません)
62    $positionGrandchildToChild = $grandchildElement->compareDocumentPosition($childElement);
63    if (($positionGrandchildToChild & Node::DOCUMENT_POSITION_CONTAINS) === Node::DOCUMENT_POSITION_CONTAINS) {
64        echo "✗ 'grandchild' 要素は 'child' 要素を含んでいます。\n";
65    } else {
66        echo "✓ 'grandchild' 要素は 'child' 要素を含んでいません。\n";
67    }
68
69    echo "\n--- 生成されたDOMドキュメント ---\n";
70    echo $dom->saveXML();
71}
72
73// 定数 Dom\Node::DOCUMENT_POSITION_CONTAINS の動作を確認するために関数を実行します。
74demonstrateDomContainsPosition();

PHP 8のDom拡張機能におけるDom\Node::DOCUMENT_POSITION_CONTAINS定数は、DOMツリー内のノード間の包含関係を判定するために使用されます。この定数自体には引数や戻り値はありませんが、Dom\NodeクラスのcompareDocumentPosition()メソッドが返すビットマスク（複数の状態を同時に表現する数値）の一部として利用されます。

サンプルコードでは、まずDom\DocumentとDom\Nodeを使用して、<root>、<child>、<grandchild>という階層構造を持つDOMツリーを構築しています。その後、各ノード間でcompareDocumentPosition()メソッドを呼び出し、その戻り値とDom\Node::DOCUMENT_POSITION_CONTAINS定数をビットAND演算子（&）で比較することで、一方のノードがもう一方のノードを含んでいるかどうかを確認しています。

具体的には、$rootElement->compareDocumentPosition($childElement)のように呼び出した場合、rootElementがchildElementを含んでいるかどうかの情報が戻り値のビットマスクに含まれています。この戻り値にDOCUMENT_POSITION_CONTAINS定数の値が含まれていれば、「参照ノード（この場合rootElement）が比較対象ノード（childElement）を含んでいる」と判定できます。これにより、DOMツリー内でのノードの親子関係や包含関係を正確かつ効率的に判断することが可能です。

Copy
1<?php
2
3/**
4 * DOMノード間の位置関係を比較するサンプルコードです。
5 *
6 * この関数は、DOM要素を作成し、それらの階層関係に基づいて
7 * ノードの位置関係を比較する方法を示します。
8 * 特に、あるノードが別のノードを含んでいるかどうか
9 * (DOMNode::DOCUMENT_POSITION_CONTAINS) を確認します。
10 *
11 * @see DOMNode::compareDocumentPosition
12 * @see DOMNode::DOCUMENT_POSITION_CONTAINS
13 */
14function demonstrateDomNodePositionComparison(): void
15{
16    // 1. 新しいDOMDocumentオブジェクトを作成し、出力を整形するように設定します。
17    $dom = new DOMDocument();
18    $dom->formatOutput = true;
19
20    // 2. 親要素 'div' を作成し、'container' というIDを付与してDOMに追加します。
21    $container = $dom->createElement('div');
22    $container->setAttribute('id', 'container');
23    $dom->appendChild($container);
24
25    // 3. 子要素 'p' を作成し、親要素 'div' の子として追加します。
26    $paragraph = $dom->createElement('p', 'これは段落です。');
27    $container->appendChild($paragraph);
28
29    // 4. 孫要素 'span' を作成し、子要素 'p' の子として追加します。
30    $span = $dom->createElement('span', 'テキスト');
31    $paragraph->appendChild($span);
32
33    // 作成されたDOM構造を出力します（理解を助けるため）。
34    echo "--- 現在のDOM構造 ---\n";
35    echo $dom->saveHTML();
36    echo "-----------------------\n\n";
37
38    // 5. ノードの位置関係を比較します。
39    // DOMNode::compareDocumentPosition() メソッドは、二つのノード間の相対的な位置関係を
40    // 示すビットマスクを返します。
41    // DOMNode::DOCUMENT_POSITION_CONTAINS は、参照ノードが比較対象のノードを
42    // 含んでいる場合（つまり参照ノードが比較対象ノードの祖先である場合）に
43    // セットされるビット値です。
44
45    // 例1: 親ノード ($container) が子ノード ($paragraph) を含んでいるか？
46    // 期待される結果: はい (DOCUMENT_POSITION_CONTAINSがセットされる)
47    $position1 = $container->compareDocumentPosition($paragraph);
48    echo "比較: 'container' ノード と 'paragraph' ノード\n";
49    echo "  'container' は 'paragraph' を含んでいますか？ ";
50    if (($position1 & DOMNode::DOCUMENT_POSITION_CONTAINS) === DOMNode::DOCUMENT_POSITION_CONTAINS) {
51        echo "はい、含んでいます。\n";
52    } else {
53        echo "いいえ、含んでいません。\n";
54    }
55    echo "\n";
56
57    // 例2: 子ノード ($paragraph) が親ノード ($container) を含んでいるか？
58    // 期待される結果: いいえ (DOCUMENT_POSITION_CONTAINSはセットされない)
59    $position2 = $paragraph->compareDocumentPosition($container);
60    echo "比較: 'paragraph' ノード と 'container' ノード\n";
61    echo "  'paragraph' は 'container' を含んでいますか？ ";
62    if (($position2 & DOMNode::DOCUMENT_POSITION_CONTAINS) === DOMNode::DOCUMENT_POSITION_CONTAINS) {
63        echo "はい、含んでいます。\n";
64    } else {
65        echo "いいえ、含んでいません。\n";
66    }
67    echo "\n";
68
69    // 例3: 祖先ノード ($container) が孫ノード ($span) を含んでいるか？
70    // 期待される結果: はい (DOCUMENT_POSITION_CONTAINSがセットされる)
71    $position3 = $container->compareDocumentPosition($span);
72    echo "比較: 'container' ノード と 'span' ノード\n";
73    echo "  'container' は 'span' を含んでいますか？ ";
74    if (($position3 & DOMNode::DOCUMENT_POSITION_CONTAINS) === DOMNode::DOCUMENT_POSITION_CONTAINS) {
75        echo "はい、含んでいます。\n";
76    } else {
77        echo "いいえ、含んでいません。\n";
78    }
79    echo "\n";
80}
81
82// サンプル関数を実行して、DOMノードの位置関係の比較結果を確認します。
83demonstrateDomNodePositionComparison();

このサンプルコードは、PHPのDOM拡張機能におけるDOMノード間の位置関係を比較する方法を示しています。特に、DOMNode::DOCUMENT_POSITION_CONTAINSという定数を用いて、あるノードが別のノードを「含んでいる」状態、つまりその祖先ノードであるかどうかを判別する仕組みを解説しています。この定数自体は引数を取らず、特定の値を示すためのものであり、戻り値もありません。

コードでは、まずDOMDocumentオブジェクトを用いて、div、p、spanといった要素を親子関係で構成するDOM構造を作成します。その後、作成された各ノードに対してDOMNode::compareDocumentPosition()メソッドを使用します。このメソッドは、二つのノード間の相対的な位置関係を示すビットマスクを返します。

このビットマスク値とDOMNode::DOCUMENT_POSITION_CONTAINS定数をビット論理積（AND演算）で比較することで、参照元のノードが比較対象のノードを含んでいるかどうかの真偽を判断できます。具体的には、親ノードが子ノードを含んでいる場合や、祖先ノードが孫ノードを含んでいる場合には「含んでいる」と判定される例が示されています。一方、子ノードが親ノードを含んでいるかを確認するような逆のケースでは「含んでいない」と判定される様子がわかりやすく示されており、DOMツリーにおけるノードの包含関係の理解に役立ちます。