【PHP8.x】DOMDocument::DOCUMENT_POSITION_PRECEDING定数の使い方

Copy
1<?php
2
3/**
4 * DOMNode::compareDocumentPosition メソッドと DOM_DOCUMENT_POSITION_PRECEDING 定数の使用例。
5 *
6 * DOM_DOCUMENT_POSITION_PRECEDING は、比較対象のノードが基準となるノードの「先行」
7 * (すなわち、ドキュメント順で先に位置する) であることを示すビットフラグです。
8 */
9function demonstrateDocumentPositionPreceding(): void
10{
11    // 新しいDOMドキュメントを作成
12    $dom = new DOMDocument('1.0', 'UTF-8');
13    $dom->formatOutput = true; // 出力整形を有効にする
14
15    // ルート要素を追加
16    $root = $dom->createElement('root');
17    $dom->appendChild($root);
18
19    // 複数の子要素を追加し、DOMツリーを構築
20    $child1 = $dom->createElement('child1');
21    $root->appendChild($child1);
22
23    $grandchild1 = $dom->createElement('grandchild1');
24    $child1->appendChild($grandchild1);
25
26    $child2 = $dom->createElement('child2');
27    $root->appendChild($child2);
28
29    echo "=== DOMNode::compareDocumentPosition と DOM_DOCUMENT_POSITION_PRECEDING 定数 ===\n\n";
30
31    // 構築されたDOMツリーを可視化
32    echo "構築されたDOMツリー:\n";
33    echo $dom->saveXML() . "\n";
34
35    // 例1: $child2 を基準として $child1 を比較
36    // $child1 は $child2 のドキュメント順で先行しているため、DOM_DOCUMENT_POSITION_PRECEDING が含まれるはずです。
37    if ($child1 && $child2) {
38        echo "比較対象ノード:\n";
39        echo "  - 基準ノード: '<child2/>'\n";
40        echo "  - 比較ノード: '<child1/>'\n";
41
42        // $child2 を基準に $child1 の位置を比較
43        $position = $child2->compareDocumentPosition($child1);
44
45        echo "compareDocumentPosition(\$child2, \$child1) の結果 (ビットマスク): " . sprintf("0x%02X", $position) . "\n";
46
47        // 結果に DOM_DOCUMENT_POSITION_PRECEDING フラグが含まれているかチェック
48        // DOM_DOCUMENT_POSITION_PRECEDING は、比較ノードが基準ノードの前に位置することを示す (値: 0x02)
49        if (($position & DOM_DOCUMENT_POSITION_PRECEDING) === DOM_DOCUMENT_POSITION_PRECEDING) {
50            echo "  -> 結果に DOM_DOCUMENT_POSITION_PRECEDING が含まれています。\n";
51            echo "     これは、'<child1/>' が '<child2/>' のドキュメント順で先行していることを意味します。\n";
52        } else {
53            echo "  -> 結果に DOM_DOCUMENT_POSITION_PRECEDING は含まれていません。\n";
54        }
55        echo "\n";
56    }
57
58    // 例2: $grandchild1 を基準として $child1 を比較
59    // $child1 は $grandchild1 の親であり、ドキュメント順でも先行します。
60    // この場合、DOM_DOCUMENT_POSITION_PRECEDING (先行) と DOM_DOCUMENT_POSITION_CONTAINED_BY (包含されている) の
61    // 両方が含まれるはずです。
62    if ($child1 && $grandchild1) {
63        echo "別の比較対象ノード:\n";
64        echo "  - 基準ノード: '<grandchild1/>'\n";
65        echo "  - 比較ノード: '<child1/>'\n";
66
67        // $grandchild1 を基準に $child1 の位置を比較
68        $position = $grandchild1->compareDocumentPosition($child1);
69
70        echo "compareDocumentPosition(\$grandchild1, \$child1) の結果 (ビットマスク): " . sprintf("0x%02X", $position) . "\n";
71
72        // DOM_DOCUMENT_POSITION_PRECEDING (値: 0x02)
73        if (($position & DOM_DOCUMENT_POSITION_PRECEDING) === DOM_DOCUMENT_POSITION_PRECEDING) {
74            echo "  -> 結果に DOM_DOCUMENT_POSITION_PRECEDING が含まれています。\n";
75            echo "     これは、'<child1/>' が '<grandchild1/>' のドキュメント順で先行していることを意味します。\n";
76        }
77        // DOM_DOCUMENT_POSITION_CONTAINED_BY は、比較ノードが基準ノードを包含することを示す (値: 0x10)
78        if (($position & DOM_DOCUMENT_POSITION_CONTAINED_BY) === DOM_DOCUMENT_POSITION_CONTAINED_BY) {
79            echo "  -> 結果に DOM_DOCUMENT_POSITION_CONTAINED_BY が含まれています。\n";
80            echo "     これは、'<child1/>' が '<grandchild1/>' を包含していることを意味します。\n";
81        }
82        echo "\n";
83    }
84}
85
86// 関数を実行
87demonstrateDocumentPositionPreceding();

PHPのDOM_DOCUMENT_POSITION_PRECEDING定数は、XMLやHTMLドキュメント内でDOMノード間の位置関係を示す整数値（ビットフラグ）の一つです。この定数は、比較対象のノードが基準となるノードよりもドキュメント順で「先行している」場合に、DOMNode::compareDocumentPositionメソッドの戻り値に含まれます。compareDocumentPositionメソッドは、二つのノード間の相対的な位置関係を示すビットマスクを整数として返します。

サンプルコードでは、まず簡単なDOMツリーを作成しています。そして、$child2ノードを基準として$child1ノードの位置を比較する例と、$grandchild1ノードを基準として$child1ノードを比較する例を示しています。最初の例では、$child1が$child2よりもドキュメント順で先行しているため、compareDocumentPositionメソッドの戻り値にDOM_DOCUMENT_POSITION_PRECEDING定数が示すビットフラグが含まれます。この含まれているかどうかは、ビット論理積演算子&を使って判定します。二番目の例では、$child1が$grandchild1の親であり、かつドキュメント順でも先行しているため、DOM_DOCUMENT_POSITION_PRECEDINGに加えて、DOM_DOCUMENT_POSITION_CONTAINED_BY（基準ノードが比較ノードに含まれている）といった他の位置関係を示すフラグも同時に含まれることがわかります。このように、この定数はDOMツリー内でのノードの順序をプログラム的に判断する際に役立ちます。

Copy
1<?php
2
3/**
4 * 指定されたHTMLコンテンツ内の2つのノードを比較し、
5 * 最初のノードが2番目のノードよりDOMツリーで前に位置するかどうかを判定します。
6 *
7 * この関数は、ウェブアプリケーションでPOSTされたHTMLデータを受け取り、
8 * そのDOM構造を分析するシナリオを想定しています。
9 *
10 * @param string $postContent POSTされたと仮定するHTMLコンテンツ。
11 * @return bool 最初のノードが2番目のノードよりDOMツリーで前に位置する場合、true。
12 *              それ以外の場合、またはDOMのロードやノード取得に失敗した場合はfalse。
13 */
14function analyzeDomNodePosition(string $postContent): bool
15{
16    // DOMDocumentオブジェクトを作成
17    $dom = new DOMDocument();
18
19    // 厳密なエラーハンドリングのためには libxml_use_internal_errors(true) を使い、
20    // libxml_get_errors() でエラーを処理するのが推奨されます。
21    // ここでは簡潔さのため、エラー抑制演算子（@）を使用しています。
22    // loadHTML() は指定されたHTML文字列をパースします。
23    @$dom->loadHTML($postContent);
24
25    // DOMが正しくロードされたか確認
26    if (!$dom->documentElement) {
27        echo "エラー: 提供されたコンテンツをDOMとしてロードできませんでした。\n";
28        return false;
29    }
30
31    // 比較対象の2つのノードを取得します。
32    // 例として、HTML内の最初の<p>要素と2番目の<p>要素を比較します。
33    $paragraphs = $dom->getElementsByTagName('p');
34
35    $nodeA = $paragraphs->item(0); // DOMツリーで先に現れると想定されるノード
36    $nodeB = $paragraphs->item(1); // DOMツリーで後に現れると想定されるノード
37
38    // 比較に必要なノードが両方存在するか確認
39    if (!$nodeA || !$nodeB) {
40        echo "エラー: 比較に必要な2つの<p>要素が見つかりませんでした。\n";
41        return false;
42    }
43
44    // DOMNode::compareDocumentPosition() メソッドを使用してノードの位置を比較します。
45    // 戻り値はビットマスクであり、複数の状態を示すことができます。
46    // DOMDocument::DOCUMENT_POSITION_PRECEDING は、
47    // 参照ノード（$nodeB）に対して比較対象ノード（$nodeA）がDOMツリーで
48    // より「前に」位置することを示します。
49    $position = $nodeA->compareDocumentPosition($nodeB);
50
51    // ビット論理AND演算子（&）を使って、
52    // DOCUMENT_POSITION_PRECEDING のビットがセットされているか確認します。
53    if (($position & DOMDocument::DOCUMENT_POSITION_PRECEDING) === DOMDocument::DOCUMENT_POSITION_PRECEDING) {
54        echo "結果: 最初のノードは2番目のノードよりDOMツリーで前に位置します。\n";
55        return true;
56    } else {
57        echo "結果: 最初のノードは2番目のノードよりDOMツリーで前に位置しません。\n";
58        return false;
59    }
60}
61
62// --- サンプル実行 ---
63// ウェブアプリケーションでPOSTされたと仮定するHTMLコンテンツ
64// このコンテンツでは、id="first" の<p>要素が id="second" の<p>要素より前に位置します。
65$sampleHtmlContent = <<<HTML
66<!DOCTYPE html>
67<html>
68<body>
69    <div id="container">
70        <p id="first">これは最初の段落です。</p>
71        <p id="second">これは2番目の段落です。</p>
72        <span>これはスパン要素です。</span>
73    </div>
74</body>
75</html>
76HTML;
77
78// 関数を実行し、結果を出力
79$isNodeAPreceding = analyzeDomNodePosition($sampleHtmlContent);
80var_dump($isNodeAPreceding); // 期待される出力: bool(true)
81

このPHPサンプルコードは、HTMLコンテンツのDOM（Document Object Model）ツリー内で、二つのノードがどのような位置関係にあるかを比較する方法を示しています。具体的には、あるノードが別のノードよりもDOMツリー上で「前に」位置するかどうかを判定するものです。

コードはまず、DOMDocumentオブジェクトを作成し、関数に渡されたHTML文字列（ウェブアプリケーションでPOSTされたコンテンツを想定しています）を解析してDOMツリーを構築します。次に、解析されたDOMツリーから特定の要素、ここでは最初の二つの<p>タグを取得します。

DOMNodeクラスのcompareDocumentPosition()メソッドは、二つのノードの位置関係を詳細に比較し、その結果を整数値（ビットマスク）で返します。サンプルコードでは、この戻り値とDOMDocument::DOCUMENT_POSITION_PRECEDING定数をビット論理AND演算子&で比較しています。DOCUMENT_POSITION_PRECEDINGは、比較対象のノードが参照ノードよりもDOMツリー上で「先に現れる」状態を示す定数です。

関数analyzeDomNodePositionは、引数$postContentとして分析したいHTML文字列を受け取ります。そして、最初のノードが二番目のノードよりDOMツリーで前に位置する場合にtrueを、それ以外の場合やノードの取得に失敗した場合はfalseをブール値として返します。この機能は、ユーザーが投稿したHTMLコンテンツの構造を検証したり、特定の要素の順序を確認したりする際に役立ちます。