いっしー@Webエンジニア
Webツールプログラミング言語プログラミング学習ITニュースIT用語辞典ポートフォリオ
Webエンジニア向けプログラミング解説動画をYouTubeで配信中！
▶ チャンネル登録はこちら

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

DOCUMENT_POSITION_FOLLOWING定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

DOCUMENT_POSITION_FOLLOWING定数は、2つのDOMノード間の文書内での位置関係を表す定数です。この定数は、主にDOMNode::compareDocumentPosition()メソッドの返り値として使用されます。このメソッドは、あるノードが別のノードに対して、文書内でどの位置にあるかを比較し、その関係をビットマスクとして返します。compareDocumentPosition()メソッドの結果にDOCUMENT_POSITION_FOLLOWINGが含まれている場合、それは比較対象のノードが、メソッドを呼び出した基準ノードよりも後に文書内で出現することを示します。これは、HTMLやXMLのソースコードにおいて、基準となる要素の終了タグよりも後に、比較対象の要素の開始タグが現れる順序関係を意味します。返り値は複数の状態を示すビットマスク値であるため、この定数とのビット単位の論理積（&演算子）をとることで、後続関係にあるかどうかを具体的に判定できます。このように、DOCUMENT_POSITION_FOLLOWINGは、DOMツリー構造をプログラムで解析し、ノードの出現順序に基づいて処理を行う際に不可欠な役割を果たします。

構文(syntax)

1<?php
2$doc = new DOMDocument();
3$doc->loadHTML('<html><body><p></p><div></div></body></html>');
4
5$p_node = $doc->getElementsByTagName('p')->item(0);
6$div_node = $doc->getElementsByTagName('div')->item(0);
7
8// $p_node から見て $div_node がドキュメント順で後にあるか比較します
9$position = $p_node->compareDocumentPosition($div_node);
10
11// 比較結果に DOCUMENT_POSITION_FOLLOWING フラグが含まれているか確認します
12if ($position & DOMEntity::DOCUMENT_POSITION_FOLLOWING) {
13    echo 'div_node は p_node の後にあります。';
14}

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

DOCUMENT_POSITION_FOLLOWING は、ノードが別のノードの後に続くことを示す整数値です。

サンプルコード

DOMノード位置比較とDOCUMENT_POSITION_FOLLOWING

1<?php
2
3/**
4 * DOMNode::compareDocumentPosition メソッドを使用して、
5 * 2つのDOMノード間の相対的な位置関係を比較するサンプル関数です。
6 *
7 * DOMNode::compareDocumentPosition は、参照ノード ($node1) から見た比較対象ノード ($node2) の位置を
8 * ビットマスクとして返します。
9 *
10 * @param string $html HTML文字列。比較するノードが含まれている必要があります。
11 * @param string $id1 最初の比較対象となるノードのID。
12 * @param string $id2 2番目の比較対象となるノードのID。
13 * @return void
14 */
15function compareDomNodePositions(string $html, string $id1, string $id2): void
16{
17    // DOMDocumentオブジェクトを作成し、HTMLをロードします。
18    // エラーが表示されるのを避けるため、@で抑制しています。
19    $dom = new DOMDocument();
20    @$dom->loadHTML($html);
21
22    // 指定されたIDを持つノードを取得します。
23    $node1 = $dom->getElementById($id1);
24    $node2 = $dom->getElementById($id2);
25
26    if (!$node1 || !$node2) {
27        echo "エラー: ID '{$id1}' または '{$id2}' を持つノードが見つかりません。\n\n";
28        return;
29    }
30
31    echo "ノード '{$id1}' と ノード '{$id2}' の比較結果:\n";
32
33    // compareDocumentPosition メソッドでノードの位置を比較します。
34    // 結果はビットマスク（複数の状態を同時に表現する整数）です。
35    $position = $node1->compareDocumentPosition($node2);
36
37    // 結果のビットマスクを各定数とビット論理積 (&) で比較し、
38    // どの位置関係が当てはまるかを確認します。
39
40    // DOMNode::DOCUMENT_POSITION_FOLLOWING: $node2 が $node1 の後に続く場合
41    if ($position & DOMNode::DOCUMENT_POSITION_FOLLOWING) {
42        echo "  - '{$id2}' は '{$id1}' の「後方」に位置します。\n";
43    }
44
45    // DOMNode::DOCUMENT_POSITION_PRECEDING: $node2 が $node1 の前に来る場合
46    if ($position & DOMNode::DOCUMENT_POSITION_PRECEDING) {
47        echo "  - '{$id2}' は '{$id1}' の「前方」に位置します。\n";
48    }
49
50    // DOMNode::DOCUMENT_POSITION_CONTAINS: $node1 が $node2 を含んでいる場合 (つまり $node2 が $node1 の子孫)
51    if ($position & DOMNode::DOCUMENT_POSITION_CONTAINS) {
52        echo "  - '{$id1}' は '{$id2}' を「含んでいます」（'{$id2}' は '{$id1}' の子孫です）。\n";
53    }
54
55    // DOMNode::DOCUMENT_POSITION_CONTAINED_BY: $node2 が $node1 を含んでいる場合 (つまり $node1 が $node2 の子孫)
56    if ($position & DOMNode::DOCUMENT_POSITION_CONTAINED_BY) {
57        echo "  - '{$id1}' は '{$id2}' に「含まれています」（'{$id1}' は '{$id2}' の子孫です）。\n";
58    }
59
60    // DOMNode::DOCUMENT_POSITION_DISCONNECTED: $node1 と $node2 が同じドキュメントツリーにない場合
61    if ($position & DOMNode::DOCUMENT_POSITION_DISCONNECTED) {
62        echo "  - '{$id1}' と '{$id2}' は「接続されていません」（異なるツリーにあります）。\n";
63    }
64
65    // ノードが完全に同じ場合は、どの位置関係のビットも立たないため、結果は0になります。
66    if ($position === 0) {
67        echo "  - '{$id1}' と '{$id2}' は「同じ」ノードを参照しています。\n";
68    }
69
70    echo "\n";
71}
72
73// 比較に使用するサンプルHTMLコンテンツ
74$htmlContent = <<<HTML
75<!DOCTYPE html>
76<html>
77<body>
78    <div id="container">
79        <p id="header-paragraph">これはヘッダー段落です。</p>
80        <div id="main-content">
81            <span id="target-span">ターゲット要素</span>
82            <p id="sub-paragraph">サブ段落</p>
83        </div>
84    </div>
85    <section id="footer-section">
86        <h2 id="footer-title">フッタータイトル</h2>
87    </section>
88</body>
89</html>
90HTML;
91
92// -------------------------------------------------------------------------------------------------
93// 実際の比較例
94// -------------------------------------------------------------------------------------------------
95
96// 例1: 後方ノードの比較
97// 'target-span' は 'header-paragraph' の「後方」に位置します。
98compareDomNodePositions($htmlContent, 'header-paragraph', 'target-span');
99
100// 例2: 前方ノードの比較 (キーワードに関連)
101// 'header-paragraph' は 'target-span' の「前方」に位置します。
102compareDomNodePositions($htmlContent, 'target-span', 'header-paragraph');
103
104// 例3: 包含関係の比較
105// 'container' は 'target-span' を「含んでいます」。
106compareDomNodePositions($htmlContent, 'container', 'target-span');
107
108// 例4: 含まれる関係の比較
109// 'target-span' は 'container' に「含まれています」。
110compareDomNodePositions($htmlContent, 'target-span', 'container');
111
112// 例5: 同じノードの比較
113// 'target-span' と 'target-span' は「同じ」ノードです。
114compareDomNodePositions($htmlContent, 'target-span', 'target-span');
115
116// 例6: 接続されていないノード (異なるDOMツリーの一部) の比較
117// 'target-span' と 'footer-title' は「接続されていません」。
118compareDomNodePositions($htmlContent, 'target-span', 'footer-title');
119

このPHPサンプルコードは、HTMLドキュメント内の二つの要素（ノード）がどのような相対的な位置関係にあるかを比較する方法を示しています。compareDomNodePositions関数は、HTML文字列と二つの要素IDを引数として受け取り、それらのノードの位置関係を判別し、その結果を画面に出力します。

核となるのはDOMNode::compareDocumentPositionメソッドで、これは基準となるノードから見た比較対象ノードの位置を、複数の状態を同時に表す整数値（ビットマスク）として返します。このメソッドの戻り値を、DOMNode::DOCUMENT_POSITION_FOLLOWINGのような特定の定数とビット論理積&で比較することで、具体的な位置関係を判断します。

DOMNode::DOCUMENT_POSITION_FOLLOWINGは、比較対象ノードが基準ノードよりもドキュメント内で後方にある場合に、このビットマスクに含まれる定数です。例えば、<p id="A"></p><div id="B"></div>というHTMLでAとBを比較すると、BはAの後方に位置するため、この定数が検出されます。キーワードであるDOMNode::DOCUMENT_POSITION_PRECEDINGは、その逆で、比較対象ノードが前方にある場合に検出されます。

このサンプルでは、さらに包含関係や、ノードが同じドキュメントツリーに属さない場合の定数も用いて、詳細な位置関係を分析しています。引数で指定したノードが存在しない場合はエラーメッセージを表示し、正常な場合は検出された位置関係のメッセージを出力し、戻り値はありません。この機能は、DOMツリーの構造を理解し、要素間の関係性に基づいて処理を行う際に非常に有用です。

DOMNode::compareDocumentPositionメソッドは、二つのノード間の複数の位置関係を同時に示す「ビットマスク」と呼ばれる整数値を返します。そのため、DOMNode::DOCUMENT_POSITION_FOLLOWINGのような特定の状態を確認するには、&演算子（ビット論理積）を使って個別に判定する必要がある点に注意してください。ノードの位置関係は、参照ノードから見た比較対象ノードの相対的な位置を示すため、どちらのノードが基準になっているか理解すると良いでしょう。また、DOMDocument::getElementByIdでノードが存在しない場合はnullを返すため、必ず取得したノードの有効性を確認してください。サンプルコードにあるDOMDocument::loadHTMLでの@によるエラー抑制は、デバッグを困難にするため本番環境での安易な利用は推奨されません。HTMLの構文エラーは適切に処理することが安全な利用に繋がります。

PHP DOMノード位置比較とPOSTパラメータ

1<?php
2
3/**
4 * 2つのDOMノードの位置関係を比較し、`DOMNode::DOCUMENT_POSITION_FOLLOWING` 定数を用いて結果を評価するサンプル関数。
5 *
6 * この関数は、HTTP POSTリクエストでXMLデータが送信され、
7 * そのデータをDOMとして処理するようなシナリオを想定しています。
8 * `@param` タグで関数の引数を説明しており、これはPOSTリクエストの「param(パラメータ)」と見立てられます。
9 *
10 * `DOMNode::DOCUMENT_POSITION_FOLLOWING` 定数は、あるノードが別のノードの後に来ることを示します。
11 * プログラミング言語リファレンス情報では「所属クラス: DOMEntity」とありますが、
12 * PHP 8においてこの定数はDOMNodeクラスに属しており、`DOMNode::DOCUMENT_POSITION_FOLLOWING` として使用するのが一般的です。
13 * `DOMEntity` は `DOMNode` を継承しているため、概念的には関連しています。
14 *
15 * @param string $xmlContent POSTリクエストで送信されたと仮定するXMLコンテンツ文字列。
16 * @return string ノードの位置関係を説明するメッセージ。
17 */
18function compareDomNodesUsingDocumentPositionFollowing(string $xmlContent): string
19{
20    // DOMDocumentを作成し、POSTデータと仮定したXMLをロードします。
21    // loadXML() で発生する可能性のある警告は、簡潔な例のため一時的に抑制します。
22    // 実際のアプリケーションでは、適切なエラーハンドリングを実装してください。
23    $dom = new DOMDocument();
24    @$dom->loadXML($xmlContent);
25
26    // 比較対象となるノードを取得します。
27    // 例として、ルート要素直下の最初の3つの子要素を比較します。
28    $nodeA = $dom->getElementsByTagName('nodeA')->item(0);
29    $nodeB = $dom->getElementsByTagName('nodeB')->item(0);
30    $nodeC = $dom->getElementsByTagName('nodeC')->item(0);
31
32    $output = "--- ノード位置関係の比較 ---\n";
33
34    if (!$nodeA || !$nodeB || !$nodeC) {
35        $output .= "エラー: 必要なノード(nodeA, nodeB, nodeC)をXMLから取得できませんでした。\n";
36        $output .= "提供されたXML: \n" . htmlspecialchars($xmlContent) . "\n";
37        return $output;
38    }
39
40    // nodeA と nodeB の位置関係を比較します。
41    // compareDocumentPosition() メソッドは、参照ノード (ここでは $nodeA) が比較対象ノード ($nodeB) と
42    // どのような位置関係にあるかを示すビットマスクを返します。
43    // DOMNode::DOCUMENT_POSITION_FOLLOWING (値: 4) は、参照ノードが他のノードの後に来ることを示します。
44    $positionAB = $nodeA->compareDocumentPosition($nodeB);
45    $output .= "ノード '" . $nodeA->nodeName . "' とノード '" . $nodeB->nodeName . "' の比較:\n";
46    if ($positionAB & DOMNode::DOCUMENT_POSITION_FOLLOWING) {
47        $output .= "  - ノードAはノードBの後に続いています。(このXML構造ではこれは誤りです)\n";
48    } else {
49        $output .= "  - ノードAはノードBの後に続いていません。(このXML構造ではこれが正しいです)\n";
50    }
51    // 参考: DOMNode::DOCUMENT_POSITION_PRECEDING (値: 2) は、参照ノードが他のノードの前に来ることを示します。
52    if ($positionAB & DOMNode::DOCUMENT_POSITION_PRECEDING) {
53        $output .= "  - ノードAはノードBの前に来ています。(このXML構造ではこれが正しいです)\n";
54    }
55
56    // 次に、nodeB と nodeA の位置関係を比較します。
57    $positionBA = $nodeB->compareDocumentPosition($nodeA);
58    $output .= "ノード '" . $nodeB->nodeName . "' とノード '" . $nodeA->nodeName . "' の比較:\n";
59    if ($positionBA & DOMNode::DOCUMENT_POSITION_FOLLOWING) {
60        $output .= "  - ノードBはノードAの後に続いています。(このXML構造ではこれが正しいです)\n";
61    } else {
62        $output .= "  - ノードBはノードAの後に続いていません。(このXML構造ではこれは誤りです)\n";
63    }
64    if ($positionBA & DOMNode::DOCUMENT_POSITION_PRECEDING) {
65        $output .= "  - ノードBはノードAの前に来ています。(このXML構造ではこれは誤りです)\n";
66    }
67
68    // nodeA と nodeC の位置関係を比較します。
69    $positionAC = $nodeA->compareDocumentPosition($nodeC);
70    $output .= "ノード '" . $nodeA->nodeName . "' とノード '" . $nodeC->nodeName . "' の比較:\n";
71    if ($positionAC & DOMNode::DOCUMENT_POSITION_FOLLOWING) {
72        $output .= "  - ノードAはノードCの後に続いています。(このXML構造ではこれは誤りです)\n";
73    } else {
74        $output .= "  - ノードAはノードCの後に続いていません。(このXML構造ではこれが正しいです)\n";
75    }
76    if ($positionAC & DOMNode::DOCUMENT_POSITION_PRECEDING) {
77        $output .= "  - ノードAはノードCの前に来ています。(このXML構造ではこれが正しいです)\n";
78    }
79    
80    // 自分自身との比較 (通常は0、または DOM_DOCUMENT_POSITION_DISCONNECTED が返されることは稀)
81    $positionAA = $nodeA->compareDocumentPosition($nodeA);
82    $output .= "ノード '" . $nodeA->nodeName . "' と自身との比較:\n";
83    $output .= "  - 結果は " . $positionAA . " (同じノードであることを示す) \n";
84
85    return $output;
86}
87
88// HTTP POSTリクエストで送信されるXMLデータをシミュレートします。
89// 例えば、ウェブフォームからユーザーがXMLデータを送信した場合を想定しています。
90$postXmlData = <<<XML
91<?xml version="1.0"?>
92<root>
93    <container>
94        <nodeA/>
95        <nodeB/>
96        <nodeC/>
97    </container>
98</root>
99XML;
100
101// 関数を実行し、結果を出力します。
102echo compareDomNodesUsingDocumentPositionFollowing($postXmlData);
103
104// 別のXMLデータで試す (必要なノードが見つからない場合)
105echo "\n========================================\n";
106echo "--- ノードが見つからない場合の例 ---\n";
107$invalidXmlData = <<<XML
108<?xml version="1.0"?>
109<root>
110    <item/>
111    <another_item/>
112</root>
113XML;
114echo compareDomNodesUsingDocumentPositionFollowing($invalidXmlData);
115
116?>

このサンプルコードは、PHPのDOM拡張機能を使用して、XMLドキュメント内の二つのノードがどのような位置関係にあるかを比較する方法を示しています。特に、DOMNode::DOCUMENT_POSITION_FOLLOWING定数を使用して、あるノードが別のノードの後に続いているかどうかを判断する例です。リファレンス情報では「所属クラス: DOMEntity」と記載されていますが、PHP 8ではDOMNodeクラスのcompareDocumentPosition()メソッドと組み合わせて使用するのが一般的です。

関数compareDomNodesUsingDocumentPositionFollowingは、HTTP POSTリクエストで送信されたと仮定するXMLコンテンツを $xmlContent 引数として受け取ります。この引数は、@paramタグによって説明されており、POSTリクエストのパラメータとして見立てられます。関数は、このXMLから特定のノードを取得し、それらのノード間の位置関係をcompareDocumentPosition()メソッドで評価します。このメソッドはビットマスクを返し、その結果とDOMNode::DOCUMENT_POSITION_FOLLOWING定数（値は整数）を論理積で比較することで、ノードの前後関係を正確に判定します。最終的に、ノードの位置関係を説明するメッセージを文字列として返します。この機能は、XML構造を解析し、特定の要素の配置を確認するようなシステム開発で役立ちます。

このコードでは、DOMNode::DOCUMENT_POSITION_FOLLOWING定数がPHP 8でDOMNodeクラスの定数であり、リファレンスのDOMEntityとは異なる点に注意してください。compareDocumentPosition()メソッドの戻り値はビットマスクのため、結果を評価するにはビットAND演算子(&)で定数と比較します。loadXML()のエラー抑制(@)は開発時の簡略化のためであり、実運用では必ず適切なエラーハンドリングを実装しましょう。また、@paramタグは関数の引数を説明するphpDocの記法であり、HTTP POSTリクエストの「パラメータ」とは別概念です。実際のPOSTデータは$_POSTなどから取得しますので混同しないようにしてください。

関連コンテンツ

関連IT用語

関連プログラミング言語