【PHP8.x】DOMProcessingInstruction::isSameNode()メソッドの使い方

Copy
1<?php
2
3/**
4 * DOMProcessingInstruction::isSameNode メソッドの使用例。
5 *
6 * この関数は、2つの DOMProcessingInstruction ノードがメモリ上で同じインスタンスを
7 * 参照しているかどうかを比較する方法を示します。
8 * `isSameNode`が`true`を返す場合、それは比較対象のノードが文書内に「存在する（空ではない）」
9 * ことを意味すると解釈し、その状況での処理の例を含みます。
10 *
11 * システムエンジニアを目指す初心者向けに、DOMノードの同一性比較の基礎を説明します。
12 */
13function demonstrateDomProcessingInstructionIsSameNode(): void
14{
15    // 1. DOMDocument を作成
16    // XMLやHTML文書の構造を扱うための基本的なクラスです。
17    $dom = new DOMDocument();
18    $dom->formatOutput = true; // 出力整形のため、見やすくします。
19
20    // 2. 複数の処理命令 (Processing Instruction) ノードを作成
21    // 処理命令は、XMLやHTMLファイルに埋め込まれる特別な指示です (例: <?php echo "Hello"; ?>)。
22    $piA = $dom->createProcessingInstruction('php', 'echo "Hello A!";');
23    $piB = $dom->createProcessingInstruction('php', 'echo "Hello B!";');
24    // piC は piA とは異なるインスタンスですが、内容（ターゲットとデータ）は同じです。
25    $piC = $dom->createProcessingInstruction('php', 'echo "Hello A!";');
26
27    // 3. ノードを文書に追加（DOMツリー内に配置）
28    // これにより、ノードが文書の一部となります。
29    $dom->appendChild($piA);
30    $dom->appendChild($piB);
31
32    echo "--- 1. 基本的な isSameNode の比較 ---\n";
33
34    // 同じインスタンスを比較した場合: trueを返します。
35    echo "piA と piA を比較: ";
36    if ($piA->isSameNode($piA)) {
37        echo "同じノードです。\n"; // この条件が満たされます。
38    } else {
39        echo "異なるノードです。\n";
40    }
41
42    // 異なるインスタンスを比較した場合 (内容が異なっても): falseを返します。
43    echo "piA と piB を比較: ";
44    if ($piA->isSameNode($piB)) {
45        echo "同じノードです。\n";
46    } else {
47        echo "異なるノードです。\n"; // この条件が満たされます。
48    }
49
50    // 内容は同じだが、異なるインスタンスを比較した場合: falseを返します。
51    // isSameNodeは内容ではなく、メモリ上のオブジェクトの同一性を確認します。
52    echo "piA と piC (内容が同じだが新しいノード) を比較: ";
53    if ($piA->isSameNode($piC)) {
54        echo "同じノードです。\n";
55    } else {
56        echo "異なるノードです。\n"; // この条件が満たされます。
57    }
58
59    echo "\n--- 2. 文書内からのノード検出と 'is not empty' の解釈 ---\n";
60
61    // 検索したい目標ノードを設定します。ここでは $piA を対象とします。
62    $targetNode = $piA;
63
64    // 文書内のすべての直接の子ノードをループして、目標ノードと同一のノードが存在するか確認します。
65    $foundTarget = false;
66    foreach ($dom->childNodes as $node) {
67        // 現在のノードが DOMProcessingInstruction 型であり、かつ目標ノードと同一であるかを確認
68        if ($node instanceof DOMProcessingInstruction && $node->isSameNode($targetNode)) {
69            // isSameNodeがtrueを返した場合、目標ノードが文書内に「存在し、空ではない」と判断できます。
70            echo "目標の処理命令ノードが見つかりました（文書内に存在し、空ではありません）。\n";
71            // 見つかったノードに対する特定の処理をここに記述できます。
72            echo "  -> 見つかったノードのデータ: " . htmlspecialchars($node->data) . "\n";
73            $foundTarget = true;
74            break; // 見つかったのでループを終了します。
75        }
76    }
77
78    if (!$foundTarget) {
79        echo "目標の処理命令ノードは文書内で見つかりませんでした。\n";
80    }
81
82    echo "\n--- 3. null との比較 ---\n";
83    // `isSameNode` メソッドの引数 `?DOMNode $otherNode` は `null` を許容します。
84    // `null` はノードではないため、常に `false` を返します。
85    echo "piA と null を比較: ";
86    if ($piA->isSameNode(null)) {
87        echo "同じノードです (これは通常発生しません)。\n";
88    } else {
89        echo "異なるノードです (nullは有効なDOMノードではありません)。\n"; // この条件が満たされます。
90    }
91}
92
93// 関数を実行して、上記で定義した処理を確認します。
94demonstrateDomProcessingInstructionIsSameNode();

PHP 8のDOMProcessingInstruction::isSameNodeメソッドは、DOMツリー内で処理命令ノードの同一性を確認するために使用されます。このメソッドは?DOMNode $otherNodeという引数を取り、比較対象のノードを指定します。引数にはノードまたはnullが渡せます。戻り値はbool型で、呼び出し元のノードと引数で渡されたノードがメモリ上でまったく同じインスタンスを指している場合にtrueを返します。

サンプルコードでは、DOMDocumentを作成し、複数のDOMProcessingInstructionノードを生成して、isSameNodeの挙動を詳しく示しています。このメソッドは、たとえ内容が同じであっても、異なるインスタンスとして作成されたノード同士ではfalseを返します。これは、内容の比較ではなく、オブジェクトそのものの同一性を判断するためです。

特に、isSameNodeがtrueを返すことは、そのノードがDOM文書内に実際に存在し、利用可能な状態（いわゆるis not emptyの状態）であると解釈できる場面もあります。コードでは、文書に追加されたノードが、その後に文書内で検索されたノードと同一であるかを確認する例を通じて、この解釈を説明しています。また、引数にnullを渡した場合、それは有効なDOMノードではないため、常にfalseが返される挙動も確認できます。このメソッドは、DOM操作において、特定のノードが期待通りに処理されているか、あるいは意図したノードと一致するかを厳密にチェックする際に役立ちます。

Copy
1<?php
2
3/**
4 * DOMProcessingInstruction::isSameNode() メソッドのサンプルコード
5 *
6 * この関数は、DOMProcessingInstruction ノードがメモリ上で同じオブジェクトを参照しているかを確認する
7 * isSameNode() メソッドの使用例を示します。
8 */
9function demonstrateIsSameNodeUsage(): void
10{
11    // 1. DOMDocument オブジェクトを作成します。
12    //    DOM ノードを作成するには DOMDocument が必要です。
13    $dom = new DOMDocument();
14
15    // 2. 最初の DOMProcessingInstruction ノードを作成します。
16    //    これはXMLの処理命令（例: <?php echo "Hello World"; ?>）を表します。
17    $piNode1 = $dom->createProcessingInstruction('php', 'echo "Hello World";');
18
19    // 3. 2番目の DOMProcessingInstruction ノードを作成します。
20    //    内容は piNode1 と同じですが、メモリ上では全く別のインスタンスです。
21    $piNode2 = $dom->createProcessingInstruction('php', 'echo "Hello World";');
22
23    // 4. piNode1 と同じオブジェクトを参照する変数を作成します。
24    //    これは、piNode1 と同じメモリ上のオブジェクトを指します。
25    $piNode1Ref = $piNode1;
26
27    echo "--- DOMProcessingInstruction::isSameNode() の使用例 ---" . PHP_EOL . PHP_EOL;
28
29    // ケース1: 異なるインスタンスのノードを比較
30    // isSameNode() はオブジェクトの同一性（ポインタが同じか）をチェックするため、
31    // 内容が同じでもインスタンスが異なれば false を返します。
32    echo "piNode1 と piNode2 (異なるインスタンス) の比較: ";
33    if ($piNode1->isSameNode($piNode2)) {
34        echo "同じノードです。 [予期しない結果]" . PHP_EOL;
35    } else {
36        echo "異なるノードです。 [期待される結果: false]" . PHP_EOL;
37    }
38
39    // ケース2: 同じインスタンスへの参照を比較
40    // piNode1Ref は piNode1 と全く同じオブジェクトを指しているため、
41    // isSameNode() は true を返します。
42    echo "piNode1 と piNode1Ref (同じインスタンスへの参照) の比較: ";
43    if ($piNode1->isSameNode($piNode1Ref)) {
44        echo "同じノードです。 [期待される結果: true]" . PHP_EOL;
45    } else {
46        echo "異なるノードです。 [予期しない結果]" . PHP_EOL;
47    }
48
49    // ケース3: null との比較
50    // isSameNode() メソッドの引数は ?DOMNode なので null を渡すことが可能です。
51    // null はどのノードとも同じオブジェクトではないため、false を返します。
52    echo "piNode1 と null の比較: ";
53    if ($piNode1->isSameNode(null)) {
54        echo "同じノードです。 [予期しない結果]" . PHP_EOL;
55    } else {
56        echo "異なるノードです。 [期待される結果: false]" . PHP_EOL;
57    }
58
59    // ケース4: 異なる種類の DOM ノードとの比較
60    // DOMElement は DOMProcessingInstruction とは異なる種類のノードであり、
61    // オブジェクトも異なるため、false を返します。
62    $rootElement = $dom->createElement('root');
63    echo "piNode1 と rootElement (異なるノードタイプ) の比較: ";
64    if ($piNode1->isSameNode($rootElement)) {
65        echo "同じノードです。 [予期しない結果]" . PHP_EOL;
66    } else {
67        echo "異なるノードです。 [期待される結果: false]" . PHP_EOL;
68    }
69}
70
71// 関数を実行してサンプルコードの動作を確認します。
72demonstrateIsSameNodeUsage();

PHP 8のDOMProcessingInstruction::isSameNodeメソッドは、二つのDOMノードがメモリ上で全く同じオブジェクトを指しているかを確認するために使用されます。引数$otherNodeには比較したい別のDOMNodeオブジェクト、またはnullを指定します。このメソッドは、もし両方のノードが同じオブジェクトを参照していればtrueを、そうでなければfalseをブール値として返します。

このサンプルコードでは、DOMDocumentを使用して二つのDOMProcessingInstructionノードを作成し、それらの同一性を検証しています。内容が同じであっても、createProcessingInstructionで個別に作成されたノードはメモリ上で異なるオブジェクトであるため、isSameNodeはfalseを返します。一方で、同じノードへの参照を比較した場合はtrueとなります。また、nullや異なる種類のDOMノード（DOMElementなど）と比較した場合も、同一のオブジェクトではないためfalseが返されることが示されています。この機能は、DOMツリー操作において特定のノードが既知のノードと完全に一致するかどうかを判断する際に役立ちます。