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

Copy
1<?php
2
3/**
4 * DOMComment::isSameNode の使用例
5 *
6 * この関数は、2つのDOMノードがDOMツリー内で同じノードを参照しているか（同一のノードであるか）を
7 * 判断する方法を示します。
8 *
9 * キーワード「isnotempty」との関連性について:
10 * isSameNode メソッドは引数として DOMNode 型のオブジェクトを期待します。
11 * PHP 8 では、null や DOMNode ではないオブジェクトを渡すと TypeError が発生します。
12 * そのため、このメソッドを安全に呼び出すためには、比較対象のノードが「nullではない」かつ
13 * 「有効な DOMNode インスタンスである」（つまり「is not empty」かつ「適切な型」）ことを
14 * 事前に確認することが重要になります。
15 */
16function demonstrateDomCommentIsSameNode(): void
17{
18    // DOMDocument オブジェクトを作成します。
19    // これはDOMノードを作成するためのコンテナとなります。
20    $dom = new DOMDocument();
21
22    // 最初のコメントノードを作成し、ドキュメントに追加します。
23    // createComment は通常 DOMComment オブジェクトを返しますが、念のためチェックします。
24    $comment1 = $dom->createComment("これは最初のコメントです。");
25    if (!$comment1) {
26        echo "エラー: 最初のコメントノードの作成に失敗しました。" . PHP_EOL;
27        return;
28    }
29    $dom->appendChild($comment1);
30
31    // $comment1 と全く同じオブジェクトを参照する別の変数を作成します。
32    $sameComment1 = $comment1;
33
34    // 異なる内容の2番目のコメントノードを作成し、ドキュメントに追加します。
35    $comment2 = $dom->createComment("これは2番目のコメントです。");
36    if (!$comment2) {
37        echo "エラー: 2番目のコメントノードの作成に失敗しました。" . PHP_EOL;
38        return;
39    }
40    $dom->appendChild($comment2);
41
42    echo "--- DOMComment::isSameNode の使用例 ---" . PHP_EOL;
43
44    // 例1: 同じオブジェクトを参照しているノードの比較
45    // $comment1 と $sameComment1 はDOMツリー内の同じノードを参照しているため、true を返します。
46    if ($comment1->isSameNode($sameComment1)) {
47        echo "コメント1 と sameComment1 は同じノードです。" . PHP_EOL;
48    } else {
49        echo "コメント1 と sameComment1 は異なるノードです。" . PHP_EOL;
50    }
51
52    // 例2: 異なるオブジェクトを参照しているノードの比較
53    // $comment1 と $comment2 はDOMツリー内の異なるノードを参照しているため、false を返します。
54    if ($comment1->isSameNode($comment2)) {
55        echo "コメント1 と コメント2 は同じノードです。" . PHP_EOL;
56    } else {
57        echo "コメント1 と コメント2 は異なるノードです。" . PHP_EOL;
58    }
59
60    // 例3: 「is not empty」の文脈での安全な比較
61    // isSameNode には DOMNode インスタンスを渡す必要があります。
62    // ここでは、比較対象が有効な DOMNode であることを確認してからメソッドを呼び出します。
63    $potentiallyInvalidNode = null; // または new stdClass(); など、DOMNodeではないオブジェクト
64
65    // 変数が null でなく、かつ DOMNode クラスのインスタンスであることを確認します。
66    // これが「is not empty」かつ「適切な型」のチェックに相当します。
67    if ($potentiallyInvalidNode instanceof DOMNode) {
68        if ($comment1->isSameNode($potentiallyInvalidNode)) {
69            echo "コメント1 と potentiallyInvalidNode は同じノードです。" . PHP_EOL;
70        } else {
71            echo "コメント1 と potentiallyInvalidNode は異なるノードです。" . PHP_EOL;
72        }
73    } else {
74        echo "変数 'potentiallyInvalidNode' は有効な DOMNode インスタンスではないため、比較をスキップしました。" . PHP_EOL;
75    }
76}
77
78// 関数を実行して、DOMComment::isSameNode の動作を確認します。
79demonstrateDomCommentIsSameNode();

PHPのDOMComment::isSameNodeメソッドは、二つのDOMノードがDOMツリー内で全く同じノードを参照しているか（同一であるか）を判断します。このメソッドはDOMNode型のオブジェクトである$otherNodeを引数として受け取り、比較対象が同じノードであればtrue、異なればfalseを真偽値（bool）として返します。

サンプルコードでは、DOMDocument内で作成された$comment1と$comment2という二つのコメントノードを用いて動作を示しています。$sameComment1は$comment1と同じオブジェクトを参照しているため、$comment1->isSameNode($sameComment1)はtrueを返します。一方、$comment1と$comment2は内容が異なり、DOMツリー上の別々のノードであるため、$comment1->isSameNode($comment2)はfalseを返します。

このメソッドは引数にDOMNodeインスタンスを厳密に期待するため、nullやDOMNodeではないオブジェクトを渡すとPHP 8でTypeErrorが発生します。そのため、安全にメソッドを呼び出すためには、比較対象のノードが「nullではない」かつ「有効なDOMNodeのインスタンスである」ことを、instanceof DOMNodeのような型チェックで事前に確認することが重要です。これはキーワード「is not empty」かつ「適切な型」であることのチェックに相当し、プログラムの安定性を高めるために役立ちます。

Copy
1<?php
2
3/**
4 * DOMComment::isSameNode() メソッドの動作を示すサンプルコード。
5 * このメソッドは、2つのノードがDOMツリー内の同じオブジェクトを参照している場合にtrueを返します。
6 * ノードの内容が同じかどうかではなく、同一のインスタンスであるかを判定します。
7 */
8function demonstrateIsSameNode(): void
9{
10    // 新しいDOMドキュメントを作成します。
11    $dom = new DOMDocument('1.0', 'UTF-8');
12
13    // 最初のコメントノードを作成します。
14    $comment1 = $dom->createComment('これは最初のコメントです。');
15    $dom->appendChild($comment1); // ドキュメントにコメントを追加します。
16
17    // 2番目のコメントノードを作成します。内容を少し変えます。
18    $comment2 = $dom->createComment('これは2番目のコメントです。');
19    $dom->appendChild($comment2); // ドキュメントにコメントを追加します。
20
21    // 3番目の変数に、$comment1と全く同じオブジェクトを代入します。
22    // これは$comment1と同じインスタンスを指します。
23    $comment3 = $comment1;
24
25    echo "isSameNode() のデモンストレーション:\n\n";
26
27    // ケース1: 同じオブジェクト自身を比較する
28    // 結果: true ($comment1は$comment1自身と同じノードです)
29    echo "コメント1 と コメント1 の比較: ";
30    var_dump($comment1->isSameNode($comment1));
31
32    // ケース2: 内容は異なるが、インスタンスも異なるノードを比較する
33    // 結果: false ($comment1と$comment2は異なるオブジェクトインスタンスです)
34    echo "コメント1 と コメント2 の比較: ";
35    var_dump($comment1->isSameNode($comment2));
36
37    // ケース3: 内容は同じで、インスタンスも同じノードを比較する (変数が同じオブジェクトを指している)
38    // 結果: true ($comment1と$comment3は同じオブジェクトインスタンスを指しています)
39    echo "コメント1 と コメント3 の比較 (コメント3はコメント1と同じオブジェクト): ";
40    var_dump($comment1->isSameNode($comment3));
41
42    // ケース4: 内容は同じでも、異なるオブジェクトとして作成されたノードを比較する（これはコメントではないが、例として）
43    // DOMTextノードなどを作成して比較することも可能ですが、今回はコメントに限定します。
44    // 仮に同じ内容の別のコメントノードを作成した場合:
45    $comment4 = $dom->createComment('これは最初のコメントです。'); // 内容は$comment1と同じだが、別のインスタンス
46    echo "コメント1 と コメント4 の比較 (内容は同じだが別のオブジェクト): ";
47    var_dump($comment1->isSameNode($comment4)); // 結果: false
48}
49
50// 関数を実行してデモンストレーションを開始します。
51demonstrateIsSameNode();
52
53?>

PHP 8のDOMComment::isSameNode()メソッドは、2つのDOMノードがDOMツリー内で全く同じオブジェクトインスタンスであるかどうかを判定するために利用されます。このメソッドは、ノードに格納されている内容が同じかどうかではなく、プログラミング上で同一のオブジェクトを参照しているかを厳密に確認する際に役立ちます。

引数DOMNode $otherNodeには比較対象となる別のDOMノードを指定します。戻り値はbool（真偽値）で、比較の結果を示します。もし2つのノードがメモリ上で同じオブジェクトを指している場合はtrueを、異なるオブジェクトであればfalseを返します。

サンプルコードでは、この挙動を具体的に示しています。 まず、$comment1と$comment2はそれぞれ異なる内容で作成された、別々のコメントノードです。これらをisSameNode()で比較すると、異なるインスタンスであるためfalseが返ります。 次に、$comment3には$comment1と全く同じオブジェクトが代入されています。このため、$comment1と$comment3を比較するとtrueが返り、両者が同じインスタンスを指していることが確認できます。 また、$comment4は$comment1と同じ内容で新たに作成されたコメントノードです。内容は同じですが、これは別のオブジェクトとして生成されているため、$comment1と$comment4を比較するとfalseが返されます。 このように、isSameNode()はDOM操作においてオブジェクトの同一性を確認する重要な手段です。