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

Copy
1<?php
2
3/**
4 * Dom\Text::isSameNode メソッドと、キーワード「isnotempty」を関連付けてデモンストレーションします。
5 *
6 * isSameNode メソッドは、2つのノードがDOMツリー内で全く同じオブジェクトを参照している場合に true を返します。
7 * このサンプルでは、キーワード「isnotempty」に沿って、テキストノードの内容が空でないことを確認してから、
8 * ノードの同一性比較を行います。
9 */
10function demonstrateDomTextIsSameNodeWithNotEmptyCheck(): void
11{
12    // DOMDocument を作成します。これはDOMノードを生成するための基盤となります。
13    $document = new DOMDocument();
14
15    // 1. 最初のテキストノードを作成します。
16    //    これは "Hello World" という内容を持つ Dom\Text クラスのインスタンスです。
17    $textNode1 = $document->createTextNode('Hello World');
18
19    // 2. 最初のテキストノードと同じ内容を持つ、別のテキストノードを作成します。
20    //    内容は同じですが、これは $textNode1 とは異なる新しい Dom\Text オブジェクトです。
21    $textNode2 = $document->createTextNode('Hello World');
22
23    // 3. 最初のテキストノードへの「同じ参照」を作成します。
24    //    これは $textNode1 と全く同じ Dom\Text オブジェクトを指します。
25    $sameReferenceToTextNode1 = $textNode1;
26
27    echo "--- Dom\\Text::isSameNode メソッドのデモンストレーション ('isnotempty' チェック付き) ---\n\n";
28
29    // キーワード「isnotempty」に沿って、textNode1 が null ではなく、
30    // かつその内容（nodeValue）が空白を除いて空でないことを確認します。
31    // Dom\Text ノードの場合、そのテキスト内容は nodeValue プロパティで取得できます。
32    if ($textNode1 !== null && trim($textNode1->nodeValue) !== '') {
33        echo "◎ TextNode1 は空ではありません。内容: '" . $textNode1->nodeValue . "'\n\n";
34
35        // ケース 1: 異なるオブジェクトのテキストノードとの比較
36        // ($textNode1 と $textNode2 は、内容が同じでもメモリ上では異なるオブジェクトです)
37        echo "比較 1: \$textNode1 と \$textNode2 の比較\n";
38        $isSameAsTextNode2 = $textNode1->isSameNode($textNode2);
39        echo "  - 結果: \$textNode1 と \$textNode2 は同じノードですか？ " . ($isSameAsTextNode2 ? 'はい' : 'いいえ') . "\n";
40        echo "  - 解説: 内容は同じですが、これらは別々に作成された異なるオブジェクトなので 'いいえ' になります。\n\n";
41
42        // ケース 2: 同じオブジェクトへの参照との比較
43        // ($textNode1 と $sameReferenceToTextNode1 は、メモリ上で全く同じオブジェクトを指しています)
44        echo "比較 2: \$textNode1 と \$sameReferenceToTextNode1 の比較\n";
45        $isSameAsSameReference = $textNode1->isSameNode($sameReferenceToTextNode1);
46        echo "  - 結果: \$textNode1 と \$sameReferenceToTextNode1 は同じノードですか？ " . ($isSameAsSameReference ? 'はい' : 'いいえ') . "\n";
47        echo "  - 解説: 同じオブジェクトを参照しているので 'はい' になります。\n\n";
48
49    } else {
50        echo "✖ TextNode1 は null であるか、または内容が空です。比較は行いません。\n";
51    }
52
53    // 参考: 内容が空のテキストノードの例
54    $emptyTextNode = $document->createTextNode('');
55    echo "\n--- 参考: 内容が空のテキストノードの例 ---\n";
56    if (trim($emptyTextNode->nodeValue) === '') {
57        echo "emptyTextNode は内容が空なので、上記の 'isnotempty' チェックでは処理されません。\n";
58    }
59}
60
61// 定義した関数を実行し、デモンストレーションを開始します。
62demonstrateDomTextIsSameNodeWithNotEmptyCheck();
63
64?>

PHP 8のDom\Text::isSameNodeメソッドは、DOMツリー内の二つのノードがメモリ上で全く同じオブジェクトを参照しているかどうかを判断するものです。このメソッドは、比較したい別のノードを引数（Dom\Node $otherNode）として受け取り、その二つのノードが同一であればtrueを、異なればfalseを真偽値（bool）として返します。

サンプルコードでは、"Hello World"という内容を持つテキストノードを例に、キーワード「isnotempty」の考え方を取り入れています。isSameNodeメソッドを呼び出す前に、テキストノードのnodeValueプロパティ（ノードの内容）が空白を除いて空ではないことをtrim($node->nodeValue) !== ''という条件で確認しています。これは、有効な内容を持つノードに対してのみ処理を進めるという実用的なアプローチです。

この「isnotempty」チェックをクリアした後、isSameNodeの挙動がデモンストレーションされます。内容が同じであっても、別々に作成されたテキストノード同士を比較すると、これらは異なるオブジェクトであるためfalseが返されます。一方、最初のテキストノードと、そのノードへの「同じ参照」を持つ変数とを比較すると、これらはメモリ上で全く同じオブジェクトを指すためtrueが返されます。

このようにisSameNodeメソッドは、ノードの内容が等しいかどうかではなく、DOMツリーにおけるノードそのもののオブジェクトとしての厳密な同一性を確認する際に利用されます。

Copy
1<?php
2
3// Dom\Document オブジェクトを作成します。
4// Dom\Text ノードは単独で存在せず、通常は Dom\Document のコンテキストで作成されます。
5$document = new Dom\Document();
6
7// 最初の Dom\Text ノードを作成します。
8// これはドキュメントのコンテキストで作成されますが、まだDOMツリーには追加されていません。
9$textNode1 = $document->createTextNode('Hello, PHP!');
10
11// 2番目の Dom\Text ノードを作成します。
12// これは $textNode1 と同じ内容ですが、メモリ上では別のオブジェクトインスタンスです。
13$textNode2 = $document->createTextNode('Hello, PHP!');
14
15// 3番目の変数に $textNode1 と同じオブジェクトインスタンスを代入します。
16// これにより、$textNode3 は $textNode1 と全く同じノードを参照します。
17$textNode3 = $textNode1;
18
19echo "--- Dom\\Text::isSameNode の使用例 ---\n\n";
20
21// 例1: 同じオブジェクトインスタンスを比較する
22// $textNode1 と $textNode3 は同じメモリ上のオブジェクトを指しているため、true を返します。
23echo "例1: \$textNode1 と \$textNode3 は同じノードですか？\n";
24$isSame1 = $textNode1->isSameNode($textNode3);
25var_dump($isSame1); // 期待される出力: bool(true)
26echo "\n";
27
28// 例2: 内容は同じだが、異なるオブジェクトインスタンスを比較する
29// $textNode1 と $textNode2 は内容が同じでも、別々に作成されたオブジェクトであるため、false を返します。
30echo "例2: \$textNode1 と \$textNode2 は同じノードですか？\n";
31$isSame2 = $textNode1->isSameNode($textNode2);
32var_dump($isSame2); // 期待される出力: bool(false)
33echo "\n";
34
35// 例3: 異なる型のノードと比較
36// isSameNode はノードの型ではなく、オブジェクトインスタンスが同じであるかをチェックします。
37// Dom\Node を継承していれば引数に渡せますが、インスタンスが異なるため false になります。
38// 例えば、Dom\Element ノードを作成して比較してみます。
39$elementNode = $document->createElement('p');
40echo "例3: \$textNode1 と \$elementNode は同じノードですか？\n";
41$isSame3 = $textNode1->isSameNode($elementNode);
42var_dump($isSame3); // 期待される出力: bool(false)
43
44?>

PHP 8のDom\Text::isSameNodeメソッドは、DOM（Document Object Model）ノードがメモリ上で全く同じオブジェクトインスタンスであるかどうかを判定するために使用されます。このメソッドはDom\Node型の引数$otherNodeを受け取り、自身と比較対象のノードが完全に同じオブジェクトインスタンスを指している場合にtrueを、そうでない場合にfalseをブール値で返します。

例えば、Dom\Document::createTextNode()メソッドを複数回呼び出して同じ内容のテキストノードを作成した場合、それらは内容が同じであってもメモリ上ではそれぞれ異なる独立したオブジェクトです。そのため、isSameNodeで比較するとfalseが返されます。

一方、あるテキストノードが作成された後、そのオブジェクトが別の変数に代入された場合、両方の変数は同じメモリ上のオブジェクトを参照することになります。この二つの変数をisSameNodeで比較すると、trueが返されます。

このメソッドはノードの内容やDOMツリーにおける位置ではなく、純粋にオブジェクトインスタンスの同一性のみをチェックします。したがって、Dom\Elementのような異なる種類のノードと比較する場合でも、オブジェクトインスタンスが異なればfalseが返されます。このメソッドは、DOM操作において「内容が同じ」ことと「メモリ上の同一オブジェクトである」ことを区別する際に役立ちます。