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

Copy
1<?php
2
3/**
4 * DOMノード間の位置関係を比較する例を示します。
5 * Dom\Node::compareDocumentPosition() メソッドを使用し、
6 * Dom\Node::DOCUMENT_POSITION_FOLLOWING および Dom\Node::DOCUMENT_POSITION_PRECEDING
7 * 定数の意味を理解するのに役立ちます。
8 *
9 * 注: リファレンスで Dom\Attr::DOCUMENT_POSITION_FOLLOWING と指定されていますが、
10 * これらの定数は Dom\Node クラスで定義されており、Dom\Attr も Dom\Node を継承しているため、
11 * Dom\Node の定数として使用するのが一般的です。
12 */
13function demonstrateDocumentPositionComparison(): void
14{
15    // 新しいDOMドキュメントを作成します。
16    $doc = new Dom\Document();
17    $doc->formatOutput = true; // XML出力を見やすくするための設定
18
19    // ドキュメントのルート要素を作成し、追加します。
20    $root = $doc->createElement('root');
21    $doc->appendChild($root);
22
23    // 比較対象となる3つの要素（ノード）を作成し、ルート要素に追加します。
24    // これらのノードは追加された順にDOMツリー内で物理的に並びます。
25    $nodeA = $doc->createElement('nodeA');
26    $root->appendChild($nodeA);
27
28    $nodeB = $doc->createElement('nodeB');
29    $root->appendChild($nodeB);
30
31    $nodeC = $doc->createElement('nodeC');
32    $root->appendChild($nodeC);
33
34    echo "--- DOM構造 ---\n";
35    echo $doc->saveXML() . "\n";
36
37    echo "--- ノード位置の比較結果 ---\n";
38
39    // nodeA と nodeB の位置関係を比較します。
40    // nodeBはnodeAの後に位置します。
41    $positionAB = $nodeA->compareDocumentPosition($nodeB);
42    // DOCUMENT_POSITION_FOLLOWING は、比較対象のノード ($nodeB) が
43    // 呼び出し元のノード ($nodeA) の「後に」位置することを示します。
44    if (($positionAB & Dom\Node::DOCUMENT_POSITION_FOLLOWING) === Dom\Node::DOCUMENT_POSITION_FOLLOWING) {
45        echo "nodeA.compareDocumentPosition(nodeB): nodeB は nodeA の後にあります (DOCUMENT_POSITION_FOLLOWING).\n";
46    }
47
48    // nodeB と nodeA の位置関係を比較します。
49    // nodeAはnodeBの前に位置します。
50    $positionBA = $nodeB->compareDocumentPosition($nodeA);
51    // DOCUMENT_POSITION_PRECEDING は、比較対象のノード ($nodeA) が
52    // 呼び出し元のノード ($nodeB) の「前に」位置することを示します。
53    if (($positionBA & Dom\Node::DOCUMENT_POSITION_PRECEDING) === Dom\Node::DOCUMENT_POSITION_PRECEDING) {
54        echo "nodeB.compareDocumentPosition(nodeA): nodeA は nodeB の前にあります (DOCUMENT_POSITION_PRECEDING).\n";
55    }
56    echo "\n";
57
58    // nodeC と nodeA の位置関係を比較します。
59    // nodeAはnodeCの前に位置します。
60    $positionCA = $nodeC->compareDocumentPosition($nodeA);
61    if (($positionCA & Dom\Node::DOCUMENT_POSITION_PRECEDING) === Dom\Node::DOCUMENT_POSITION_PRECEDING) {
62        echo "nodeC.compareDocumentPosition(nodeA): nodeA は nodeC の前にあります (DOCUMENT_POSITION_PRECEDING).\n";
63    }
64
65    // nodeA と nodeC の位置関係を比較します。
66    // nodeCはnodeAの後に位置します。
67    $positionAC = $nodeA->compareDocumentPosition($nodeC);
68    if (($positionAC & Dom\Node::DOCUMENT_POSITION_FOLLOWING) === Dom\Node::DOCUMENT_POSITION_FOLLOWING) {
69        echo "nodeA.compareDocumentPosition(nodeC): nodeC は nodeA の後にあります (DOCUMENT_POSITION_FOLLOWING).\n";
70    }
71}
72
73// 上記の関数を実行します。
74demonstrateDocumentPositionComparison();

このPHPサンプルコードは、DOMツリー内のノード間で、どちらが「前」にあり、どちらが「後」にあるかといった位置関係を比較する方法を示します。

主要なメソッドはDom\Node::compareDocumentPosition()で、これは比較対象のノードが呼び出し元のノードに対してどの位置にあるかを示す整数値を戻り値として返します。この戻り値は複数のビットフラグの組み合わせです。

Dom\Node::DOCUMENT_POSITION_FOLLOWING定数は、比較対象のノードが呼び出し元のノードの「後」に続くことを示します。一方、Dom\Node::DOCUMENT_POSITION_PRECEDING定数は、比較対象のノードが呼び出し元のノードの「前」に位置することを示すフラグです。

サンプルコードでは、まず3つの要素ノード「nodeA」「nodeB」「nodeC」を順に作成し、DOMツリーに追加しています。そして、例えばnodeAがnodeBを比較すると、nodeBがnodeAの後に続くため、compareDocumentPosition()の結果にDOCUMENT_POSITION_FOLLOWINGのフラグが含まれることをビット論理積（&）演算子で確認します。同様に、逆の比較ではDOCUMENT_POSITION_PRECEDINGのフラグが確認できます。

これらの定数は、リファレンスではDom\Attrクラスに属すると記載されていますが、実際にはDom\Nodeクラスで定義されており、Dom\AttrもDom\Nodeを継承しているため、Dom\Nodeの定数として利用するのが一般的です。

Copy
1<?php
2
3/**
4 * 二つのDOMノードの位置関係をチェックし、
5 * 最初のノードが二番目のノードの文書順で後に位置するかを判定します。
6 *
7 * この関数はDOMNode::compareDocumentPosition() メソッドを使用し、
8 * その結果をDOMNode::DOCUMENT_POSITION_FOLLOWING 定数と論理AND演算して、
9 * 指定されたノードが「後続」の位置にあるかどうかを確認します。
10 *
11 * @param \DOMNode $node1 比較対象の最初のノード。このノードが$node2の後に位置するかを調べます。
12 * @param \DOMNode $node2 比較対象の二番目のノード。
13 * @return bool node1がnode2の文書順で後に位置する場合にtrueを返します。
14 */
15function isNodeFollowing(\DOMNode $node1, \DOMNode $node2): bool
16{
17    // compareDocumentPosition() メソッドは、二つのノード間の相対位置を示すビットマスクを返します。
18    // DOMNode::DOCUMENT_POSITION_FOLLOWING 定数は、最初のノードが二番目のノードの
19    // 文書ツリー上で「後」に位置することを示すビットフラグです。
20    $position = $node1->compareDocumentPosition($node2);
21
22    // 戻り値のビットマスクとDOCUMENT_POSITION_FOLLOWING 定数を論理AND演算します。
23    // 結果がゼロでなければ、DOCUMENT_POSITION_FOLLOWING フラグが設定されている（つまり、後に続く）
24    // ことを意味します。
25    return (bool)($position & \DOMNode::DOCUMENT_POSITION_FOLLOWING);
26}
27
28// 以下は、isNodeFollowing関数が単体で動作する様子を示すサンプルコードです。
29
30// 1. DOMDocument オブジェクトを作成し、HTMLコンテンツをロードします。
31//    PHP 8では、DOM拡張のクラスは名前空間付き（例: Dom\Document）で提供されますが、
32//    互換性のためにグローバルエイリアス（例: DOMDocument）も利用可能です。
33$dom = new DOMDocument();
34$dom->loadHTML('
35<!DOCTYPE html>
36<html>
37<body>
38    <div id="container">
39        <p id="first-paragraph">最初の段落</p>
40        <span id="target-span">ターゲットのスパン</span>
41        <a href="#" id="following-link">続くリンク</a>
42    </div>
43    <div id="another-div">別のセクション</div>
44</body>
45</html>
46');
47
48// 2. 比較対象となる特定のDOMノードをIDで取得します。
49$firstParagraph = $dom->getElementById('first-paragraph');
50$targetSpan = $dom->getElementById('target-span');
51$followingLink = $dom->getElementById('following-link');
52$anotherDiv = $dom->getElementById('another-div');
53
54// 3. リファレンス情報で「所属クラス: Dom\Attr」と指定されているため、
55//    属性ノード (Dom\Attr または DOMAttr) を使用した例も示します。
56//    DOMAttrクラスもDOMNodeを継承しているため、compareDocumentPositionメソッドを使用できます。
57$spanIdAttr = null;
58if ($targetSpan instanceof DOMElement) {
59    // getAttributeNode() は DOMAttr オブジェクトを返します。
60    $spanIdAttr = $targetSpan->getAttributeNode('id');
61}
62
63// 4. 取得したノードが存在するか確認し、それぞれの位置関係をチェックして結果を出力します。
64echo "--- DOM ノードの位置関係チェック ---\n";
65
66if ($firstParagraph && $targetSpan && $followingLink && $anotherDiv && $spanIdAttr) {
67    // 例1: 兄弟ノード間の比較
68    // 'following-link' は 'target-span' の文書順で後にありますか？
69    if (isNodeFollowing($followingLink, $targetSpan)) {
70        echo "✅ 'following-link' は 'target-span' の文書順で後にあります。\n";
71    } else {
72        echo "❌ 'following-link' は 'target-span' の文書順で後にありません。\n";
73    }
74
75    // 例2: 逆方向の比較
76    // 'target-span' は 'following-link' の文書順で後にありますか？
77    if (isNodeFollowing($targetSpan, $followingLink)) {
78        echo "❌ 'target-span' は 'following-link' の文書順で後にありません。\n";
79    } else {
80        echo "✅ 'target-span' は 'following-link' の文書順で後にありません。\n";
81    }
82
83    // 例3: 親子関係ではないが、文書順で後にあるケース
84    // 'another-div' は 'first-paragraph' の文書順で後にありますか？
85    if (isNodeFollowing($anotherDiv, $firstParagraph)) {
86        echo "✅ 'another-div' は 'first-paragraph' の文書順で後にあります。\n";
87    } else {
88        echo "❌ 'another-div' は 'first-paragraph' の文書順で後にありません。\n";
89    }
90
91    // 例4: Dom\Attr (属性ノード) を使った比較
92    // 'following-link' は 'target-span' のID属性ノードの文書順で後にありますか？
93    if (isNodeFollowing($followingLink, $spanIdAttr)) {
94        echo "✅ 'following-link' は 'target-span' のID属性ノードの文書順で後にあります。\n";
95    } else {
96        echo "❌ 'following-link' は 'target-span' のID属性ノードの文書順で後にありません。\n";
97    }
98    
99    // 例5: 属性ノードと要素ノードの逆方向比較
100    // 'target-span' のID属性ノードは 'following-link' の文書順で後にありますか？
101    if (isNodeFollowing($spanIdAttr, $followingLink)) {
102        echo "❌ 'target-span' のID属性ノードは 'following-link' の文書順で後にありません。\n";
103    } else {
104        echo "✅ 'target-span' のID属性ノードは 'following-link' の文書順で後にありません。\n";
105    }
106
107} else {
108    echo "エラー: HTMLドキュメントから必要なDOM要素の一部またはすべてが見つかりませんでした。\n";
109}
110

このサンプルコードは、PHPのDOM拡張機能を利用して、ウェブページ内の二つの要素（ノード）が文書の記述順でどちらが先か後かを判定する方法を示しています。isNodeFollowing関数は、比較したい二つの\DOMNodeオブジェクトを引数として受け取り、最初のノードが二番目のノードよりも文書順で後に位置する場合にはtrueを、そうでなければfalseを返します。この関数は内部でDOMNode::compareDocumentPosition()メソッドを使用しており、その結果にDOMNode::DOCUMENT_POSITION_FOLLOWING定数（最初のノードが後続であることを示すフラグ）が含まれているかを調べています。

コードの実行部では、まずDOMDocumentオブジェクトでHTML構造を読み込み、getElementByIdメソッドなどを使って特定の要素ノードや、その属性ノード（DOMAttr）を取得します。取得したノード同士をisNodeFollowing関数で比較し、「このリンクはあのスパンの後にありますか？」といった具体的な問いに対する結果を画面に表示します。リファレンス情報にDom\Attrが含まれている通り、属性ノードも比較対象として扱えることが示されており、ウェブページの複雑な構造の中から、特定の要素やその属性が他の要素に対してどの位置にあるかを正確に判断するための基礎的な技術を学ぶことができます。