【PHP8.x】DOMProcessingInstruction::DOCUMENT_POSITION_DISCONNECTED定数の使い方

Copy
1<?php
2
3/**
4 * DOMNode::compareDocumentPosition() メソッドを使用して、
5 * 異なるDOMノード間の位置関係を比較するサンプルコードです。
6 *
7 * この関数は、XML_DOCUMENT_POSITION_DISCONNECTED と XML_DOCUMENT_POSITION_PRECEDING を含む、
8 * さまざまな位置関係の定数がどのように返されるかを示します。
9 * DOMProcessingInstruction クラスのインスタンスも比較対象として含めます。
10 *
11 * @see https://www.php.net/manual/ja/domnode.comparedocumentposition.php
12 * @see https://www.php.net/manual/ja/dom.constants.php
13 */
14function compareDomNodePositions(): void
15{
16    // 新しいDOMドキュメントを作成し、XML宣言を設定
17    $dom = new DOMDocument('1.0', 'UTF-8');
18    $dom->formatOutput = true; // 出力を整形して見やすくする
19
20    // ルート要素 '<root>' を作成し、ドキュメントに追加
21    $root = $dom->createElement('root');
22    $dom->appendChild($root);
23
24    // 処理命令 (Processing Instruction) を作成し、ルート要素の最初の子として追加
25    // DOMProcessingInstruction クラスのインスタンスを使用します
26    $processingInstruction = $dom->createProcessingInstruction('php', 'echo "Hello World";');
27    $root->appendChild($processingInstruction);
28
29    // 通常の要素 '<elementA>' を作成し、処理命令の後に続くように追加
30    $elementA = $dom->createElement('elementA', 'Content for A');
31    $root->appendChild($elementA);
32
33    // 別の要素 '<elementB>' を作成し、elementA の後に続くように追加
34    $elementB = $dom->createElement('elementB', 'Content for B');
35    $root->appendChild($elementB);
36
37    echo "--- DOM ノード位置関係の比較 ---" . PHP_EOL . PHP_EOL;
38
39    // --- ケース1: 異なるドキュメントに属するノードの比較 ---
40    // 結果: XML_DOCUMENT_POSITION_DISCONNECTED
41    // 完全に別のDOMドキュメントを作成し、その中のノードと比較することで、
42    // 両ノードが互いに接続されていない（Disconnected）状態を示します。
43    $otherDom = new DOMDocument();
44    $otherRoot = $otherDom->createElement('otherRoot');
45    $otherDom->appendChild($otherRoot);
46
47    echo "◆ ケース1: 異なるドキュメントに属するノードの比較" . PHP_EOL;
48    $result1 = $root->compareDocumentPosition($otherRoot);
49    echo "  - 'root' ノード ('現在のDOM') と 'otherRoot' ノード ('別のDOM') の位置関係: " . $result1 . PHP_EOL;
50    if ($result1 & XML_DOCUMENT_POSITION_DISCONNECTED) {
51        echo "    -> フラグ: XML_DOCUMENT_POSITION_DISCONNECTED (両ノードは異なるドキュメントツリーに属しています)" . PHP_EOL;
52    }
53    echo PHP_EOL;
54
55    // --- ケース2: 処理命令と後続要素の比較 ---
56    // 結果: XML_DOCUMENT_POSITION_PRECEDING / XML_DOCUMENT_POSITION_FOLLOWING
57    // 'processingInstruction' が 'elementA' の物理的に前に位置するため、
58    // 'elementA' から見て 'processingInstruction' は 'XML_DOCUMENT_POSITION_PRECEDING' となります。
59    echo "◆ ケース2: 処理命令と後続要素の比較" . PHP_EOL;
60    $result2 = $elementA->compareDocumentPosition($processingInstruction);
61    echo "  - 'elementA' から 'processingInstruction' の位置関係: " . $result2 . PHP_EOL;
62    if ($result2 & XML_DOCUMENT_POSITION_PRECEDING) {
63        echo "    -> フラグ: XML_DOCUMENT_POSITION_PRECEDING ('processingInstruction' は 'elementA' の前に位置します)" . PHP_EOL;
64    }
65
66    // 逆の比較：'processingInstruction' から見て 'elementA' は後に位置します。
67    $result3 = $processingInstruction->compareDocumentPosition($elementA);
68    echo "  - 'processingInstruction' から 'elementA' の位置関係: " . $result3 . PHP_EOL;
69    if ($result3 & XML_DOCUMENT_POSITION_FOLLOWING) {
70        echo "    -> フラグ: XML_DOCUMENT_POSITION_FOLLOWING ('elementA' は 'processingInstruction' の後に位置します)" . PHP_EOL;
71    }
72    echo PHP_EOL;
73
74    // --- ケース3: 親子ノード間の比較 ---
75    // 結果: XML_DOCUMENT_POSITION_CONTAINS / XML_DOCUMENT_POSITION_CONTAINED_BY
76    // 'root' が 'processingInstruction' を含んでいるため、それらの位置関係を示します。
77    echo "◆ ケース3: 親ノードと子ノードの比較" . PHP_EOL;
78    $result4 = $root->compareDocumentPosition($processingInstruction);
79    echo "  - 'root' から 'processingInstruction' の位置関係: " . $result4 . PHP_EOL;
80    if ($result4 & XML_DOCUMENT_POSITION_CONTAINS) {
81        echo "    -> フラグ: XML_DOCUMENT_POSITION_CONTAINS ('root' は 'processingInstruction' を含んでいます)" . PHP_EOL;
82    }
83
84    $result5 = $processingInstruction->compareDocumentPosition($root);
85    echo "  - 'processingInstruction' から 'root' の位置関係: " . $result5 . PHP_EOL;
86    if ($result5 & XML_DOCUMENT_POSITION_CONTAINED_BY) {
87        echo "    -> フラグ: XML_DOCUMENT_POSITION_CONTAINED_BY ('processingInstruction' は 'root' に含まれています)" . PHP_EOL;
88    }
89    echo PHP_EOL;
90}
91
92// サンプル関数を実行
93compareDomNodePositions();

PHPのDOM拡張機能は、XMLやHTMLドキュメントの構造をプログラムで操作するための機能を提供します。このサンプルコードは、DOMNodeクラスが持つcompareDocumentPosition()メソッドを使って、異なるDOMノード間の相対的な位置関係を比較する方法を示しています。このメソッドは、比較対象のノードが基準となるノードに対して、どこに位置するかを示す整数値を返します。この整数値はビットフラグの組み合わせであり、複数の位置関係を同時に表現できます。

特に注目すべき定数としてXML_DOCUMENT_POSITION_DISCONNECTEDがあります。これは、比較する二つのノードが全く異なるドキュメントツリーに属しており、互いに接続されていない状態を示すものです。また、XML_DOCUMENT_POSITION_PRECEDINGは、比較対象のノードが基準ノードの物理的に前に位置する場合に設定されるフラグです。この他にも、後に続く関係や親子関係を示すフラグも利用されます。

サンプルでは、XMLの処理命令（DOMProcessingInstructionクラスのインスタンス）も他の要素ノードと同様に比較対象として扱えることを示しています。これにより、ドキュメント内のあらゆる種類のノードについて、その構造上の位置を詳細に分析し、プログラムでの操作判断に役立てることが可能です。

Copy
1<?php
2
3/**
4 * このサンプルコードは、DOMノード間の「配置関係」（position / disposition）を比較し、
5 * DOMProcessingInstruction::DOCUMENT_POSITION_DISCONNECTED 定数の意味を実演します。
6 *
7 * DOMProcessingInstruction::DOCUMENT_POSITION_DISCONNECTED は、2つのノードが異なるツリーに属しているか、
8 * あるいは同じツリー内であっても直接的な関連性（親子、兄弟、先祖子孫など）がない場合に、
9 * DOMNode::compareDocumentPosition() メソッドから返されるビットマスク定数です。
10 *
11 * システムエンジニアを目指す初心者の方へ：
12 * DOM（Document Object Model）は、HTMLやXML文書をプログラムで操作するためのAPIです。
13 * このコードは、異なるノードが文書ツリー上でどのように「配置」されているか、その「位置関係」を判断する方法を示します。
14 */
15function demonstrateDomNodePositionComparison(): void
16{
17    // 1. DOMドキュメントの準備
18    // 新しいDOMドキュメントを作成し、サンプルXMLを読み込みます。
19    $dom = new DOMDocument();
20    $dom->loadXML('<root><item1><child1/></item1><item2/></root>');
21
22    // 既存のドキュメントからノードを取得します。
23    $rootNode = $dom->documentElement; // <root>
24    $item1Node = $rootNode->firstChild; // <item1>
25    $child1Node = $item1Node->firstChild; // <child1>
26
27    // 2. DOMProcessingInstructionノードの作成
28    // このProcessing InstructionノードはまだどのDOMドキュメントにも追加されていません。
29    // そのため、他のノードとは「切断された」関係にあります。
30    $piNode = new DOMProcessingInstruction('php', 'echo "Hello world!";');
31
32    echo "--- DOMノードの配置関係の比較 ---" . PHP_EOL;
33
34    // 3. 独立したノードとの比較
35    // $piNode は $dom ドキュメントに追加されていないため、$rootNode とは切断されています。
36    $positionFromDisconnected = $piNode->compareDocumentPosition($rootNode);
37
38    echo PHP_EOL;
39    echo "[$piNode->nodeName (独立)] と [$rootNode->nodeName] の比較:" . PHP_EOL;
40    if ($positionFromDisconnected & DOMProcessingInstruction::DOCUMENT_POSITION_DISCONNECTED) {
41        echo "  -> 結果: DOMProcessingInstruction::DOCUMENT_POSITION_DISCONNECTED がセットされています。" . PHP_EOL;
42        echo "  理由: Processing Instructionノードはまだドキュメントツリーに追加されていないため、rootノードとは切断された関係にあります。" . PHP_EOL;
43    } else {
44        echo "  -> 結果: DOMProcessingInstruction::DOCUMENT_POSITION_DISCONNECTED はセットされていません。" . PHP_EOL;
45    }
46
47    // 4. 同じドキュメント内のノード同士の比較
48    // $item1Node と $child1Node は親子関係にあるため、切断されていません。
49    $positionFromConnected = $item1Node->compareDocumentPosition($child1Node);
50
51    echo PHP_EOL;
52    echo "[$item1Node->nodeName] と [$child1Node->nodeName] の比較:" . PHP_EOL;
53    if ($positionFromConnected & DOMProcessingInstruction::DOCUMENT_POSITION_DISCONNECTED) {
54        echo "  -> 結果: DOMProcessingInstruction::DOCUMENT_POSITION_DISCONNECTED がセットされています。" . PHP_EOL;
55    } else {
56        echo "  -> 結果: DOMProcessingInstruction::DOCUMENT_POSITION_DISCONNECTED はセットされていません。" . PHP_EOL;
57        echo "  理由: <item1>は<child1>の親ノードであり、文書ツリー内で関連性があります。" . PHP_EOL;
58    }
59
60    // 5. Processing Instructionノードをドキュメントに追加後の比較
61    // $piNode を $dom ドキュメントのルートに追加します。
62    $dom->appendChild($piNode);
63    echo PHP_EOL;
64    echo "Processing Instructionノードをドキュメントの末尾に追加しました。" . PHP_EOL;
65
66    // ドキュメントに追加された $piNode と $rootNode を再度比較します。
67    // $piNode は $dom の子、$rootNode も $dom の子なので、同じツリー内の兄弟のような関係になります。
68    $positionAfterAdd = $piNode->compareDocumentPosition($rootNode);
69
70    echo PHP_EOL;
71    echo "[$piNode->nodeName (追加後)] と [$rootNode->nodeName] の比較:" . PHP_EOL;
72    if ($positionAfterAdd & DOMProcessingInstruction::DOCUMENT_POSITION_DISCONNECTED) {
73        echo "  -> 結果: DOMProcessingInstruction::DOCUMENT_POSITION_DISCONNECTED がセットされています。" . PHP_EOL;
74    } else {
75        echo "  -> 結果: DOMProcessingInstruction::DOCUMENT_POSITION_DISCONNECTED はセットされていません。" . PHP_EOL;
76        echo "  理由: Processing Instructionノードがドキュメントツリーに追加されたため、文書上の関連性が生まれました。" . PHP_EOL;
77        echo "  (この場合、両ノードは同じドキュメントツリー内にありますが、親子・先祖子孫関係ではありません。)" . PHP_EOL;
78    }
79}
80
81// 関数を実行して、DOMノードの比較結果を確認します。
82demonstrateDomNodePositionComparison();
83
84?>

PHPのDOMProcessingInstruction::DOCUMENT_POSITION_DISCONNECTED定数について、サンプルコードを通してシステムエンジニアを目指す初心者の方向けに説明します。この定数は引数を取らず、整数値（int）を返します。DOMはHTMLやXML文書をプログラムで操作するためのAPIです。この定数は、主にDOMNode::compareDocumentPosition()メソッドが返すビットマスクの一部として使用され、2つのDOMノード間の「配置関係」が「切断されている」状態を示します。

具体的には、比較対象の2つのノードが全く異なるDOMツリーに属している場合や、同じツリー内にあっても親子、兄弟、先祖子孫といった直接的な関連性がない場合に、この定数が結果にセットされます。

サンプルコードでは、まず新しいDOMドキュメントを作成し、いくつかのノードを取得します。次に、まだどのドキュメントにも追加されていない独立したDOMProcessingInstructionノードを作成します。この独立したノードとドキュメント内のノードを比較すると、両者は「切断された」関係にあるため、DOCUMENT_POSITION_DISCONNECTEDが検出されます。一方で、親と子の関係にあるノード同士を比較した場合は、関連性があるためこの定数は検出されません。最後に、独立していたノードをドキュメントに追加し、再度比較することで、ノードがドキュメントツリーに組み込まれた結果、「切断された」状態ではなくなる様子を示しています。これにより、ノードが文書内でどのように関連しているかをプログラムで判断する際の基礎を学ぶことができます。