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

Copy
1<?php
2
3/**
4 * Dom\Attr::isSameNode メソッドのサンプルコード
5 *
6 * この関数は、Dom\Attr クラスの isSameNode メソッドの動作をデモンストレーションします。
7 * isSameNode は、2つの Dom\Node オブジェクトがメモリ上で同じインスタンスを参照しているか
8 * （つまり、同じノードであるか）をチェックし、bool 値を返します。
9 * キーワード 'php isnotempty' に関連して、DOM オブジェクトが null でないこと
10 * （つまり、有効なノードであること）の確認もコードに含めています。
11 */
12function demonstrateDomAttrIsSameNode(): void
13{
14    echo "--- Dom\\Attr::isSameNode() のデモンストレーション ---\n\n";
15
16    // 1. 新しい Dom\Document を作成し、XML 文字列をロードします。
17    //    これにより、操作する要素と属性を持つ DOM ツリーが構築されます。
18    $dom = new Dom\Document();
19    $dom->loadXML('<root><item id="first" value="data1"></item><item id="second" value="data2"></item></root>');
20
21    // 2. 比較対象となる Dom\Element オブジェクトを取得します。
22    //    getElementsByTagName() は DomNodeList を返すため、item(0) で最初の要素を取得します。
23    $itemElement = $dom->getElementsByTagName('item')->item(0);
24
25    // 'php isnotempty' に関連して、要素が正常に取得できたか（null でないか）を確認します。
26    if ($itemElement === null) {
27        echo "エラー: 'item' 要素が見つかりませんでした。\n";
28        return;
29    }
30
31    // 3. 取得した要素から Dom\Attr オブジェクトを取得します。
32    //    attributes->getNamedItem() は指定された名前の属性ノードを返します。
33    $attrId = $itemElement->attributes->getNamedItem('id');
34    $attrValue = $itemElement->attributes->getNamedItem('value');
35
36    // 'php isnotempty' に関連して、属性が正常に取得できたか（null でないか）を確認します。
37    if ($attrId === null || $attrValue === null) {
38        echo "エラー: 'id' または 'value' 属性が見つかりませんでした。\n";
39        return;
40    }
41
42    echo "取得した属性ノード:\n";
43    echo "  \$attrId (id='first'): " . $attrId->nodeValue . "\n";
44    echo "  \$attrValue (value='data1'): " . $attrValue->nodeValue . "\n\n";
45
46    // 4. isSameNode() メソッドを使用してノードの同一性を比較します。
47
48    // ケース1: 同じ Dom\Attr オブジェクトを参照しているか？
49    //   $attrId と $attrId は明らかに同じオブジェクトなので true を返します。
50    echo "比較1: \$attrId と \$attrId は同じノードですか？\n";
51    $result1 = $attrId->isSameNode($attrId);
52    var_dump($result1); // bool(true) が期待されます。
53    echo "\n";
54
55    // ケース2: 異なる Dom\Attr オブジェクトを参照しているか？
56    //   $attrId と $attrValue は異なる属性ノードなので false を返します。
57    echo "比較2: \$attrId と \$attrValue は同じノードですか？\n";
58    $result2 = $attrId->isSameNode($attrValue);
59    var_dump($result2); // bool(false) が期待されます。
60    echo "\n";
61
62    // ケース3: 同じ属性を再度取得した場合（多くの場合、同じ参照が返されます）
63    //   DOM 実装によっては、同じ属性を再取得しても新しいオブジェクトが作成されることも
64    //   ありますが、PHP の Dom\Document では通常、同じオブジェクトの参照が返されます。
65    $reFetchedAttrId = $itemElement->attributes->getNamedItem('id');
66
67    // 'php isnotempty' に関連して、再取得した属性が null でないかを確認します。
68    if ($reFetchedAttrId === null) {
69        echo "エラー: 'id' 属性の再取得に失敗しました。\n";
70        return;
71    }
72
73    echo "比較3: \$attrId と再取得した \$reFetchedAttrId は同じノードですか？\n";
74    $result3 = $attrId->isSameNode($reFetchedAttrId);
75    var_dump($result3); // bool(true) が期待されます。
76    echo "\n";
77
78    // ケース4: 別の要素の属性と比較する場合
79    //   異なる要素の同じ名前の属性は、通常、異なるオブジェクトとして扱われます。
80    $anotherItemElement = $dom->getElementsByTagName('item')->item(1);
81    if ($anotherItemElement === null) {
82        echo "エラー: 2番目の 'item' 要素が見つかりませんでした。\n";
83        return;
84    }
85    $attrIdOfAnotherItem = $anotherItemElement->attributes->getNamedItem('id');
86
87    // 'php isnotempty' に関連して、属性が null でないかを確認します。
88    if ($attrIdOfAnotherItem === null) {
89        echo "エラー: 2番目の 'item' 要素の 'id' 属性が見つかりませんでした。\n";
90        return;
91    }
92
93    echo "比較4: \$attrId (1番目のitem) と \$attrIdOfAnotherItem (2番目のitem) は同じノードですか？\n";
94    $result4 = $attrId->isSameNode($attrIdOfAnotherItem);
95    var_dump($result4); // bool(false) が期待されます。
96    echo "\n";
97
98    // 注意点: isSameNode() の引数は Dom\Node 型です。
99    // PHP 8 では、型ヒントにより null を直接渡すと TypeError が発生します。
100    // そのため、引数が有効な Dom\Node オブジェクトであることを常に確認する必要があります
101    // (これは 'php isnotempty' の概念と密接に関連しています)。
102    echo "補足: isSameNode() の引数に null を直接渡すことはできません (TypeError)。\n";
103    echo "      引数が有効な Dom\\Node であるか（null でないか）の確認が重要です。\n";
104    echo "      例: if (\$otherNode !== null) { \$attrId->isSameNode(\$otherNode); }\n\n";
105
106    echo "--- デモンストレーション終了 ---\n";
107}
108
109// 関数の実行
110demonstrateDomAttrIsSameNode();
111
112?>

PHP 8のDom\Attr::isSameNodeメソッドは、XMLやHTMLのDOM（Document Object Model）を操作する際に、2つのDOMノードがメモリ上で同じオブジェクトインスタンスであるかを確認するために使用されます。このメソッドはDom\Attrクラスのインスタンスから呼び出され、引数として比較対象となるDom\Node型のオブジェクト（$otherNode）を受け取ります。もし、メソッドを呼び出したノードと引数に渡されたノードが完全に同じオブジェクトを指している場合、戻り値としてtrue（真）を返し、異なるオブジェクトであればfalse（偽）を返します。

サンプルコードでは、XMLから構築したDOMツリーから複数の属性ノードを取得し、isSameNode()メソッドを使ってそれらの同一性を比較しています。例えば、同じ属性ノード同士を比較すればtrue、異なる属性ノードであればfalseとなります。また、同じ属性を再度取得した場合でも、通常は同じオブジェクトインスタンスが返されるためtrueとなりますが、異なる要素の同名属性はfalseを返します。引数に渡すDom\NodeがnullであるとTypeErrorが発生するため、ノードが正常に取得できたか（nullでないか）の確認、つまりphp isnotemptyの考え方を取り入れることが、堅牢なコードを書く上で非常に重要です。

Copy
1<?php
2
3/**
4 * Dom\Attr::isSameNode() メソッドのサンプルコード
5 *
6 * このスクリプトは、2つの Dom\Attr ノードがメモリ上で同じインスタンスを指しているか
7 * どうかを判断する Dom\Attr::isSameNode() メソッドの使用方法を示します。
8 */
9
10// 1. 新しいDOMDocumentを作成します。これはHTMLやXMLドキュメントを表現するための基本です。
11$dom = new DOMDocument();
12
13// 2. ドキュメントに要素（例: div）を作成し、追加します。
14$element = $dom->createElement('div');
15$dom->appendChild($element);
16
17// 3. 作成した要素に属性（例: id="myId"）を設定します。
18$element->setAttribute('id', 'myId');
19
20// 4. 要素から 'id' 属性を Dom\Attr オブジェクトとして取得します。
21// これは、ドキュメントツリー内に存在する実際の属性ノードです。
22$attrNode1 = $element->getAttributeNode('id');
23echo "最初の属性ノード: " . $attrNode1->name . " = " . $attrNode1->value . "\n";
24
25// 5. 同じ要素から同じ 'id' 属性を再度取得します。
26// DomDocumentはノードをキャッシュするため、これは通常、既存のノードへの参照を返します。
27$attrNode2 = $element->getAttributeNode('id');
28echo "2番目の属性ノード (同じノードを再取得): " . $attrNode2->name . " = " . $attrNode2->value . "\n";
29
30// 6. 新しい Dom\Attr オブジェクトを独立して作成します。
31// これは 'id' という名前ですが、まだドキュメントツリーには追加されておらず、
32// 上記の $attrNode1 や $attrNode2 とは異なるインスタンスです。
33$attrNode3 = $dom->createAttribute('id');
34$attrNode3->value = 'anotherId'; // 異なる値を設定して識別しやすくします。
35echo "3番目の属性ノード (新規作成): " . $attrNode3->name . " = " . $attrNode3->value . "\n\n";
36
37// 7. isSameNode() メソッドを使用して、ノードが同じであるかを比較します。
38
39// 比較 1: $attrNode1 と $attrNode2
40// 同じ要素から同じ属性を取得しているため、これらは通常同じノードインスタンスです。
41$isSame1 = $attrNode1->isSameNode($attrNode2);
42echo "attrNode1 と attrNode2 は同じノードですか？ " . ($isSame1 ? 'はい' : 'いいえ') . "\n";
43// 期待される出力: はい (true)
44
45// 比較 2: $attrNode1 と $attrNode3
46// $attrNode1 はドキュメントツリーにあるノード、$attrNode3 は新規作成された独立したノードです。
47// これらは異なるインスタンスです。
48$isSame2 = $attrNode1->isSameNode($attrNode3);
49echo "attrNode1 と attrNode3 は同じノードですか？ " . ($isSame2 ? 'はい' : 'いいえ') . "\n";
50// 期待される出力: いいえ (false)
51
52?>

Dom\Attr::isSameNode()メソッドは、PHP 8のDOM操作機能の一つで、比較対象のDom\Nodeオブジェクトが、メソッドを呼び出したDom\Attrオブジェクトとメモリ上で全く同じインスタンスであるかどうかを判断します。引数には比較したい別のノードを一つ指定し、両者が同じインスタンスであればtrueを、そうでなければfalseをブール値として返します。

このメソッドは、属性の名前や値が同じかどうかではなく、オブジェクトの参照そのものが一致するかどうかを厳密にチェックします。例えば、同じHTML要素から特定の属性を複数回取得した場合、通常は同じDom\Attrインスタンスへの参照が返されるため、isSameNode()はtrueを返します。これは、DOMDocumentが内部的にノードを管理し、重複したオブジェクトの生成を避けるためです。

しかし、たとえ同じ名前と値を持つ属性であっても、それが独立して新規作成されたオブジェクトインスタンスである場合、既存のノードとは異なるオブジェクトとして扱われるため、isSameNode()はfalseを返します。この機能は、DOMツリーの操作において、ノードの物理的な同一性を正確に識別する必要がある場合に特に有用です。