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

Copy
1<?php
2
3/**
4 * DOMCharacterData::isSameNode メソッドの使用例をデモンストレーションします。
5 *
6 * このメソッドは、2つのノードが同じオブジェクトを参照しているかどうかを判定します。
7 * DOMCharacterData は DOMText や DOMComment などの親クラスです。
8 * isSameNode メソッドは DOMNode クラスから継承されており、DOMText のような
9 * DOMCharacterData を継承するクラスのインスタンスで利用できます。
10 *
11 * キーワード「php isnotempty」との関連付けとして、isSameNode を呼び出す前に
12 * 比較対象のノードが null (空) でないことを確認する処理を含めます。
13 */
14function demonstrateDomCharacterDataIsSameNode(): void
15{
16    // DOMDocument オブジェクトを作成
17    $dom = new DOMDocument('1.0', 'UTF-8');
18    $dom->formatOutput = true; // 出力されるXMLを整形します
19
20    // ルート要素を作成し、ドキュメントに追加
21    $rootElement = $dom->createElement('root');
22    $dom->appendChild($rootElement);
23
24    // 最初のテキストノードを作成 (DOMCharacterData を継承する DOMText を使用)
25    $textNode1 = $dom->createTextNode('最初のテキストノード');
26    $rootElement->appendChild($textNode1);
27
28    // textNode1 と全く同じノードオブジェクトを参照する別の変数
29    $textNode1_reference = $textNode1;
30
31    // 別の内容を持つ、異なるテキストノードを作成
32    $textNode2 = $dom->createTextNode('二番目のテキストノード');
33    $rootElement->appendChild($textNode2);
34
35    echo "--- DOMCharacterData::isSameNode の動作確認 ---\n\n";
36
37    // ケース1: 同じノードオブジェクトへの参照を比較
38    // 比較対象 ($textNode1_reference) が null (空) でないことを確認します。
39    // これがキーワード「isnotempty」の適用例となります。
40    if ($textNode1_reference !== null) { // textNode1_reference が null でないか (is not empty)
41        if ($textNode1->isSameNode($textNode1_reference)) {
42            echo "ケース1: textNode1 と textNode1_reference は同じノードです。\n"; // true を返します
43        } else {
44            echo "ケース1: textNode1 と textNode1_reference は異なるノードです。\n";
45        }
46    } else {
47        echo "ケース1: 比較対象の textNode1_reference が null (空) です。\n";
48    }
49    echo "\n";
50
51    // ケース2: 異なるノードオブジェクトを比較
52    // 比較対象 ($textNode2) が null (空) でないことを確認します。
53    if ($textNode2 !== null) { // textNode2 が null でないか (is not empty)
54        if ($textNode1->isSameNode($textNode2)) {
55            echo "ケース2: textNode1 と textNode2 は同じノードです。\n";
56        } else {
57            echo "ケース2: textNode1 と textNode2 は異なるノードです。\n"; // false を返します
58        }
59    } else {
60        echo "ケース2: 比較対象の textNode2 が null (空) です。\n";
61    }
62    echo "\n";
63
64    // ケース3: 比較対象が null の場合（「isnotempty」が false の場合）
65    $nullNode = null;
66    echo "--- 比較対象が null (空) の場合 ---\n";
67    if ($nullNode !== null) { // nullNode が null でないか (is not empty) を確認
68        // このブロックは実行されません。
69        // isSameNode メソッドは引数に DOMNode を期待するため、null を直接渡すのは通常避けるべきです。
70        // ここでは、null でないことを確認する重要性を示しています。
71        if ($textNode1->isSameNode($nullNode)) {
72            echo "ケース3: textNode1 と nullNode は同じノードです。\n";
73        } else {
74            echo "ケース3: textNode1 と nullNode は異なるノードです。\n";
75        }
76    } else {
77        echo "ケース3: nullNode は null (空) です。isSameNode は呼び出されません。\n";
78    }
79    echo "\n";
80
81    echo "--- 生成されたXMLドキュメント ---\n";
82    echo $dom->saveXML();
83}
84
85// デモンストレーション関数を実行
86demonstrateDomCharacterDataIsSameNode();
87
88?>

PHP 8のDOMCharacterData::isSameNodeメソッドは、XMLやHTMLドキュメントを操作する際に、二つのノードがメモリ上で全く同じオブジェクトを参照しているかどうかを判定するために利用されます。このメソッドはDOMCharacterDataクラスに属しており、DOMTextやDOMCommentといった、文字列データを扱うノードの親クラスから継承されています。

引数には比較対象となる別のノードをDOMNode $otherNodeとして指定します。メソッドは、両方のノードが同一のオブジェクトを指していればtrueを、そうでなければfalseを真偽値（bool）として返します。これはノードの「内容」が同じかどうかではなく、「オブジェクト自体」が同じかどうかを判断するものです。

サンプルコードでは、DOMDocument内に作成した複数のテキストノードを用いてisSameNodeの動作を示しています。まず、同じノードオブジェクトへの参照を比較するケースではtrueが返されます。次に、異なる内容を持つ別々のノードオブジェクトを比較するケースではfalseが返されることを確認できます。また、キーワード「isnotempty」の概念と関連付けて、比較対象のノードがnull（空）でないかをif ($otherNode !== null)のように事前に確認する処理を組み込んでいます。これは、isSameNodeメソッドが有効なDOMNodeオブジェクトを期待するため、予期せぬエラーを避けるための安全なプログラミング習慣です。比較対象がnullの場合には、メソッドが呼び出されないように制御しています。

Copy
1<?php
2
3/**
4 * DOMCharacterData::isSameNode() メソッドの動作を示すサンプルコードです。
5 * このメソッドは、2つのノードがメモリ上で同じオブジェクトであるかどうかを判定します。
6 * 見た目や内容が同じであっても、異なるオブジェクトであれば false を返します。
7 */
8
9// DOMDocument を作成します。これはXML/HTMLドキュメント全体を表現するオブジェクトです。
10$dom = new DOMDocument('1.0', 'UTF-8');
11$dom->formatOutput = true; // 出力を整形して読みやすくします。
12
13// ルート要素（<root>）を作成し、DOMドキュメントに追加します。
14$rootElement = $dom->createElement('root');
15$dom->appendChild($rootElement);
16
17// 最初のテキストノードを作成します。DOMCharacterDataのサブクラスであるDOMTextのインスタンスです。
18$textNode1 = $dom->createTextNode('Hello World');
19$rootElement->appendChild($textNode1); // ルート要素にこのテキストノードを追加します。
20
21// 2番目のテキストノードを作成します。内容は同じですが、新しい独立したオブジェクトです。
22$textNode2 = $dom->createTextNode('Hello World');
23$rootElement->appendChild($textNode2); // ルート要素にこのテキストノードを追加します。
24
25// 最初のテキストノード ($textNode1) への別の参照を作成します。
26// これは $textNode1 と全く同じオブジェクトを指します。
27$textNode1Ref = $textNode1;
28
29echo "DOMCharacterData::isSameNode() メソッドの動作確認:\n";
30echo "---------------------------------------------------\n";
31
32// ケース1: 同じノード自身と比較
33// $textNode1 と $textNode1 は、当然ながら同じオブジェクトなので true を返します。
34echo "1. \$textNode1 と \$textNode1 は同じノードですか？ (期待値: true)\n";
35var_dump($textNode1->isSameNode($textNode1));
36
37// ケース2: 内容は同じだが、異なるオブジェクトのノードと比較
38// $textNode1 と $textNode2 は内容が同じですが、メモリ上の別々のオブジェクトなので false を返します。
39echo "2. \$textNode1 と \$textNode2 は同じノードですか？ (期待値: false)\n";
40var_dump($textNode1->isSameNode($textNode2));
41
42// ケース3: 同じノードオブジェクトへの異なる参照と比較
43// $textNode1 と $textNode1Ref は、同じメモリ上のオブジェクトを指しているので true を返します。
44echo "3. \$textNode1 と \$textNode1Ref は同じノードですか？ (期待値: true)\n";
45var_dump($textNode1->isSameNode($textNode1Ref));
46
47// ケース4: 異なる種類のノードと比較
48// $textNode1 は DOMText、$rootElement は DOMElement であり、種類もオブジェクトも異なるので false を返します。
49echo "4. \$textNode1 (テキスト) と \$rootElement (要素) は同じノードですか？ (期待値: false)\n";
50var_dump($textNode1->isSameNode($rootElement));
51
52?>

PHPのDOMCharacterData::isSameNode()メソッドは、DOM（Document Object Model）における2つのノードが、メモリ上で全く同じオブジェクトであるかどうかを判定するために使用されます。このメソッドは、テキストノードやコメントノードなど、DOMCharacterDataを継承するクラスのオブジェクトから呼び出すことができます。

このメソッドは、引数として比較したい別のノード（DOMNode型のオブジェクト）を受け取ります。戻り値は真偽値（bool）で、比較対象の2つのノードがメモリ上で同一のオブジェクトであればtrueを、異なるオブジェクトであればfalseを返します。

例えば、同じ「Hello World」という文字列を持つテキストノードを2つ作成した場合、それぞれはメモリ上で独立した異なるオブジェクトとして扱われるため、isSameNode()メソッドで比較するとfalseが返されます。これは、ノードの内容が同じであっても、それが別々に作られたオブジェクトであると判断されるためです。一方で、あるノードオブジェクトに対して別の変数で参照を作成した場合、それらは同じメモリ上のオブジェクトを指しているため、isSameNode()はtrueを返します。このメソッドは、ノードの持つ値や属性ではなく、純粋なオブジェクトの同一性を確認したい場合に非常に役立ちます。