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

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::isSameNode の使用方法と、オブジェクトの存在チェック (isnotempty) との関連性を示す関数。
5 *
6 * このメソッドは、2つの Dom\Node オブジェクトが実際に同じオブジェクト（メモリ上の同じインスタンス）であるかを比較します。
7 * 'php isnotempty' のキーワードは、変数が空でないか、特にオブジェクトが null でないかを確認する文脈で関連します。
8 * isSameNode は ?Dom\Node を引数に取るため、null が渡された場合の動作も考慮に入れることが重要です。
9 */
10function demonstrateXmlDocumentIsSameNode(): void
11{
12    // 1. 2つの新しい XMLDocument オブジェクトを作成します。
13    // Dom\XMLDocument は Dom\Node を継承しているため、isSameNode メソッドを使用できます。
14    $docA = new Dom\XMLDocument('1.0', 'UTF-8');
15    $docA->formatOutput = true; // 出力整形を有効にする
16    $docA->appendChild($docA->createElement('rootA')); // ルート要素を追加
17
18    $docB = new Dom\XMLDocument('1.0', 'UTF-8');
19    $docB->formatOutput = true;
20    $docB->appendChild($docB->createElement('rootB'));
21
22    // 2. docA と同じオブジェクトを参照する変数を作成します。
23    $docC = $docA; // $docC は $docA と同じインスタンスを指す
24
25    echo "--- Dom\\XMLDocument::isSameNode のデモンストレーション ---\n";
26
27    // シナリオ1: ドキュメント自身と比較する
28    // オブジェクトは常に自身と同じノードです。
29    $isSameSelf = $docA->isSameNode($docA);
30    echo "Is docA the same node as docA? " . ($isSameSelf ? 'Yes' : 'No') . " (期待値: Yes)\n";
31
32    // シナリオ2: 異なるドキュメントオブジェクトと比較する
33    // 内容が似ていても、異なるインスタンスであれば同じノードではありません。
34    $isSameDifferentDoc = $docA->isSameNode($docB);
35    echo "Is docA the same node as docB? " . ($isSameDifferentDoc ? 'Yes' : 'No') . " (期待値: No)\n";
36
37    // シナリオ3: 同じオブジェクトを参照する別の変数と比較する
38    // 同じインスタンスを指しているため、同じノードと見なされます。
39    $isSameReferencedDoc = $docA->isSameNode($docC);
40    echo "Is docA the same node as docC (which references docA)? " . ($isSameReferencedDoc ? 'Yes' : 'No') . " (期待値: Yes)\n";
41
42    // シナリオ4: ドキュメントと、その子要素と比較する
43    // ドキュメントノードと要素ノードは異なるタイプのノードであるため、同じノードではありません。
44    $rootA = $docA->getElementsByTagName('rootA')->item(0);
45    if ($rootA !== null) { // $rootA が null でないことを確認する（オブジェクトの存在チェック）
46        $isDocAndChildSame = $docA->isSameNode($rootA);
47        echo "Is docA the same node as its root element ('rootA')? " . ($isDocAndChildSame ? 'Yes' : 'No') . " (期待値: No)\n";
48    } else {
49        echo "エラー: rootA が見つかりませんでした。\n";
50    }
51
52    // シナリオ5: 存在しないノード（null）と比較する
53    // isSameNode メソッドは ?Dom\Node を引数に取るため、null が渡されてもエラーにならず false を返します。
54    $nonExistentNode = null;
55    $isSameWithNull = $docA->isSameNode($nonExistentNode);
56    echo "Is docA the same node as a non-existent node (null)? " . ($isSameWithNull ? 'Yes' : 'No') . " (期待値: No)\n";
57    echo "  -> これは、null と比較しても isSameNode がエラーを発生させず、false を返すことを示しています。\n";
58
59    echo "\n--- 'php isnotempty' (オブジェクトの存在/nullチェック) との関連性 ---\n";
60
61    // 'php isnotempty' というキーワードは、変数が値を持っているか、オブジェクトが null でないかを確認する際によく使われます。
62    // DOM オブジェクトを扱う際も、ノードが実際に取得できたか（null でないか）を確認することは非常に重要です。
63
64    if ($nonExistentNode === null) {
65        echo "変数 'nonExistentNode' は null です（実質的にオブジェクト参照としては空/存在しません）。\n";
66    } else {
67        // このブロックは $nonExistentNode が null でない場合に実行されます。
68        echo "変数 'nonExistentNode' は null ではありません。\n";
69    }
70
71    if ($rootA !== null) { // これはオブジェクト参照における 'isnotempty' の一種のチェックです。
72        echo "変数 'rootA' は null ではありません（ノードが存在し、空ではありません）。\n";
73        // ここで $rootA に対する安全な操作を実行できます。
74    } else {
75        echo "変数 'rootA' は null です。\n";
76    }
77}
78
79// デモンストレーション関数を実行します。
80demonstrateXmlDocumentIsSameNode();
81
82?>

PHP 8のDom\XMLDocument::isSameNodeメソッドは、二つのDom\Nodeオブジェクトがメモリ上で同じインスタンスを指しているかどうかを比較するために使用されます。このメソッドは、引数として?Dom\Node $otherNodeを受け取ります。引数の前の?は、Dom\Nodeオブジェクトだけでなくnullも渡せることを示しています。比較の結果はbool（真偽値）で返され、同じインスタンスであればtrue、そうでなければfalseとなります。

サンプルコードでは、変数$docAとそれと同じオブジェクトを参照する$docCを比較するとtrueが返り、内容が異なりインスタンスも異なる$docBと比較するとfalseとなることが確認できます。また、isSameNodeメソッドにnullを渡した場合でもエラーにはならず、安全にfalseが返される挙動も示されています。

関連キーワードである「php isnotempty」は、変数が空でないか、特にオブジェクトがnullでないかを確認する文脈で非常に重要です。DOM操作では、ノードを取得する際に目的の要素が見つからないとnullが返されることがあります。そのため、取得したノードをisSameNodeメソッドの引数として渡す前や、そのノードに対して何らかの操作を行う前に、if ($node !== null)のようにnullチェックを行い、オブジェクトが実際に存在することを確認することが、予期せぬエラーを防ぐ上で不可欠です。

Copy
1<?php
2
3// Dom\XMLDocument クラスを使って、XML ドキュメントを作成します。
4$xml = new Dom\XMLDocument();
5// XMLコンテンツをロードします。
6$xmlContent = '<root><item id="1">Node A</item><item id="2">Node B</item><item id="3">Node C</item></root>';
7$xml->loadXML($xmlContent);
8
9// XML ドキュメントから複数の Dom\Node オブジェクトを取得します。
10// getElementsByTagName は指定されたタグ名を持つ要素の Dom\NodeList を返します。
11// item(index) メソッドでリスト内の特定のノードにアクセスできます。
12$nodeA = $xml->getElementsByTagName('item')->item(0); // 最初の <item> ノード
13$nodeB = $xml->getElementsByTagName('item')->item(1); // 2番目の <item> ノード
14
15// 最初のノード ($nodeA) と全く同じオブジェクトを参照する変数を作成します。
16$sameNodeA = $nodeA;
17
18echo "--- Dom\\Node::isSameNode() の使用例 ---\n\n";
19
20// 例1: 同じノードへの参照を比較する
21// $nodeA と $sameNodeA はメモリ上で全く同じオブジェクトインスタンスを指しているため、
22// isSameNode() は true を返します。
23echo "1. \$nodeA と \$sameNodeA は同じノードか？ (同じオブジェクト参照):\n";
24var_dump($nodeA->isSameNode($sameNodeA));
25echo "\n";
26
27// 例2: 異なるノードを比較する
28// $nodeA と $nodeB はDOMツリー上の異なるオブジェクトインスタンスです。
29// 内容が似ていても、isSameNode() は異なるオブジェクトであれば false を返します。
30echo "2. \$nodeA と \$nodeB は同じノードか？ (異なるオブジェクト参照):\n";
31var_dump($nodeA->isSameNode($nodeB));
32echo "\n";
33
34// PHP 8 の Dom\Node::isSameNode メソッドは、引数として Dom\Node 型を期待します。
35// リファレンス情報で ?Dom\Node とあっても、null を直接渡すと TypeError が発生します。
36// そのため、ここでは null を引数に渡す例は含みません。

このサンプルコードは、PHP 8で利用できるDom\NodeクラスのisSameNodeメソッドの使用方法を示しています。このメソッドは、2つのDom\Nodeオブジェクトがメモリ上で完全に同じインスタンスを参照しているかどうかを判定し、その結果を真偽値（bool）で返します。

まず、Dom\XMLDocumentクラスのインスタンスを作成し、loadXMLメソッドでXMLコンテンツをロードしています。その後、getElementsByTagNameとitemメソッドを使用して、XMLドキュメントから特定のDom\Nodeオブジェクト（XML要素）を取得しています。

isSameNodeメソッドは、引数として比較対象のDom\Nodeオブジェクト（$otherNode）を一つ受け取ります。 サンプルコードの例1では、$nodeAと全く同じオブジェクトを参照する$sameNodeAを比較しています。これらはメモリ上で同じオブジェクトインスタンスを指しているため、isSameNodeはtrueを返します。 一方、例2では、DOMツリー上の異なる位置にある$nodeAと$nodeBを比較しています。これらはたとえ内容が似ていても、異なるオブジェクトインスタンスであるため、isSameNodeはfalseを返します。

このメソッドは、ノードの内容ではなく、オブジェクトの厳密な「同一性」を確認したい場合に利用されます。戻り値は比較結果を示すbool型です。なお、引数には?Dom\Nodeとありますが、nullを直接渡すとTypeErrorが発生するため、常にDom\Nodeオブジェクトを渡す必要があります。