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

Copy
1<?php
2
3// システムエンジニアを目指す初心者の方へ：
4// このコードは、XMLドキュメント内で定義される「エンティティ」という概念と、
5// それらが同じものかどうかを比較する「isSameNode」メソッドの使い方を示します。
6// キーワード「php isnotempty」に関連して、比較対象のノードが「空ではないか（nullではないか）」
7// という観点も考慮した例を含みます。
8
9// 1. XMLドキュメントの準備
10// DOMDocumentはXMLやHTMLドキュメントをオブジェクトとして扱うためのクラスです。
11// ここでは内部DTD（Document Type Definition）を使って 'example' と 'another' というエンティティを定義しています。
12$xmlString = <<<XML
13<!DOCTYPE root [
14    <!ENTITY example "Hello World">
15    <!ENTITY another "Another Value">
16]>
17<root/>
18XML;
19
20$dom = new DOMDocument();
21// XML文字列をDOMDocumentにロードします。
22// `true` を渡すと、ロード時の警告（例えば外部DTDがない場合など）をエラーとして扱わず、
23// 処理を続行させることができます。
24$dom->loadXML($xmlString, LIBXML_NOERROR);
25
26// 2. Dom\Entity オブジェクトの取得
27// DOMDocumentTypeオブジェクトを通して、定義されたエンティティにアクセスします。
28// `Dom\Entity` は、DTDで定義されたエンティティを表すノードです。
29$doctype = $dom->doctype;
30
31$entity1 = null;
32$entity2 = null;
33$entityAnother = null;
34$entityNull = null; // 比較用に意図的にnullのノードを用意
35
36// ドキュメントタイプが存在し、かつエンティティが定義されていることを確認します。
37// ここで、$doctype->entities が null でないか（is not empty）を確認しています。
38if ($doctype && $doctype->entities) {
39    // 'example' という名前のエンティティを取得します。
40    // 同じ名前で複数回取得しても、同じノードインスタンスを参照します。
41    $entity1 = $doctype->entities->getNamedItem('example');
42    $entity2 = $doctype->entities->getNamedItem('example');
43
44    // 別のエンティティ 'another' を取得します。
45    $entityAnother = $doctype->entities->getNamedItem('another');
46}
47
48echo "--- Dom\\Entity::isSameNode() の使用例 ---\n";
49
50// 3. isSameNode メソッドによるノードの比較
51// isSameNode は、2つのノードが同じオブジェクト（参照）であるかをチェックします。
52// 値が同じかどうかではなく、メモリ上の同じノードであるかを判断します。
53if ($entity1 instanceof Dom\Entity) { // $entity1 が null ではない（is not empty）ことを確認
54
55    // 3-1. 同じエンティティ（同じ参照）同士の比較
56    // $entity1 と $entity2 は、getNamedItem('example') によって同じエンティティノードを参照しています。
57    $isSame_1_2 = $entity1->isSameNode($entity2);
58    echo "  \$entity1 と \$entity2 は同じノードですか？ " . ($isSame_1_2 ? "はい (true)" : "いいえ (false)") . "\n";
59    // 期待される結果: はい (true)
60
61    // 3-2. 異なるエンティティ（異なる参照）同士の比較
62    // $entity1 と $entityAnother は異なるエンティティ名で取得されたため、異なるノードです。
63    // ここでも、比較対象の $entityAnother が null ではないことを確認しています。
64    if ($entityAnother instanceof Dom\Entity) {
65        $isSame_1_Another = $entity1->isSameNode($entityAnother);
66        echo "  \$entity1 と \$entityAnother は同じノードですか？ " . ($isSame_1_Another ? "はい (true)" : "いいえ (false)") . "\n";
67        // 期待される結果: いいえ (false)
68    } else {
69        echo "  \$entityAnother の取得に失敗しました。\n";
70    }
71
72    // 3-3. 比較対象が null の場合の比較
73    // isSameNode の引数 `$otherNode` は `?Dom\Node` となっており、null を渡すことが可能です。
74    // null はどのノードとも同じではないため、この比較は常に `false` を返します。
75    // これは「比較対象のノードが空（null）である」ケースの例です。
76    $isSame_1_Null = $entity1->isSameNode($entityNull);
77    echo "  \$entity1 と null は同じノードですか？ " . ($isSame_1_Null ? "はい (true)" : "いいえ (false)") . "\n";
78    // 期待される結果: いいえ (false)
79
80} else {
81    echo "エラー: Dom\\Entity オブジェクトの取得に失敗しました。XMLの構造を確認してください。\n";
82}
83
84?>

PHPのDom\Entity::isSameNodeメソッドは、XMLドキュメント内で定義されるエンティティノードが「同じオブジェクト（参照）」であるかを比較するために使用されます。ここでいう「同じ」とは、ノードが持つ値が同じかどうかではなく、メモリ上で同じインスタンスを指しているかどうかを意味します。

このメソッドは引数として ?Dom\Node $otherNode を取ります。これは、比較したい別のノードを Dom\Node 型で渡すか、あるいは null を渡すことができることを示します。nullが渡された場合、そのノードはどのノードとも同じではないため、結果は常にfalseとなります。これは、比較対象のノードが「空ではないか（is not empty）」という観点も考慮する際に重要です。

メソッドの戻り値は bool 型で、比較した2つのノードが同じオブジェクトであれば true を、異なるオブジェクトであれば false を返します。例えば、同じエンティティを複数回取得した場合、それらは同じノードインスタンスを参照するためtrueが返されますが、異なる名前のエンティティやnullと比較した場合はfalseとなります。このメソッドは、XMLドキュメント内で特定のノードが既に処理済みであるか、あるいは特定のノードの同一性を厳密に確認したい場合に役立ちます。

Copy
1<?php
2
3/**
4 * Dom\Entity::isSameNode メソッドの使用例を示します。
5 * このメソッドは、2つのノードがDOMツリー内で同じノードであるかどうかを判断します。
6 * 主に、同じエンティティを指す異なるオブジェクトが実際に同じDOMノードであるかを確認するのに役立ちます。
7 */
8function demonstrateDomEntityIsSameNode(): void
9{
10    // DTD (Document Type Definition) でエンティティを定義した XML 文字列
11    $xmlString = <<<XML
12<!DOCTYPE document [
13  <!ENTITY company "Example Corp.">
14  <!ENTITY product "Awesome Product">
15]>
16<document>
17  <paragraph>&company; &product;</paragraph>
18</document>
19XML;
20
21    // Dom\Document オブジェクトを作成し、XML をロードします。
22    $dom = new Dom\Document();
23    $dom->loadXML($xmlString);
24
25    // Dom\DocumentType オブジェクトを取得します。DTD にアクセスするために必要です。
26    $doctype = $dom->doctype;
27
28    if ($doctype === null) {
29        echo "エラー: DTD が見つかりませんでした。\n";
30        return;
31    }
32
33    // ドキュメントタイプから定義されているエンティティのマップ (Dom\NamedNodeMap) を取得します。
34    $entities = $doctype->entities;
35
36    if ($entities === null) {
37        echo "エラー: エンティティが見つかりませんでした。\n";
38        return;
39    }
40
41    // 同じエンティティ "company" を指す Dom\Entity オブジェクトを2つ取得します。
42    // Dom\NamedNodeMap::getNamedItem() は毎回同じDOMノードへの参照を返します。
43    $entityCompany1 = $entities->getNamedItem('company');
44    $entityCompany2 = $entities->getNamedItem('company');
45
46    // 別のエンティティ "product" を指す Dom\Entity オブジェクトを取得します。
47    $entityProduct = $entities->getNamedItem('product');
48
49    // ノードが Dom\Entity のインスタンスであることを確認します。
50    if (!$entityCompany1 instanceof Dom\Entity ||
51        !$entityCompany2 instanceof Dom\Entity ||
52        !$entityProduct instanceof Dom\Entity) {
53        echo "エラー: 期待する Dom\\Entity ノードを取得できませんでした。\n";
54        return;
55    }
56
57    echo "--- Dom\\Entity::isSameNode の使用例 --- \n";
58
59    // ケース1: 同じDOMノードを指す2つのDom\Entityオブジェクトを比較します。
60    // どちらも同じ 'company' エンティティノードを指すため、true が返されます。
61    $isSameNode1 = $entityCompany1->isSameNode($entityCompany2);
62    echo "entityCompany1 と entityCompany2 は同じノードですか？ " . ($isSameNode1 ? "はい" : "いいえ") . "\n"; // 出力: はい
63
64    // ケース2: 異なるDOMノードを指す2つのDom\Entityオブジェクトを比較します。
65    // 'company' と 'product' は異なるエンティティノードであるため、false が返されます。
66    $isSameNode2 = $entityCompany1->isSameNode($entityProduct);
67    echo "entityCompany1 と entityProduct は同じノードですか？ " . ($isSameNode2 ? "はい" : "いいえ") . "\n"; // 出力: いいえ
68
69    // ケース3: Dom\Node オブジェクトと null を比較します。
70    // null はノードではないため、false が返されます。
71    $isSameNode3 = $entityCompany1->isSameNode(null);
72    echo "entityCompany1 と null は同じノードですか？ " . ($isSameNode3 ? "はい" : "いいえ") . "\n"; // 出力: いいえ
73
74    // ケース4: Dom\Entity オブジェクトと、DOMツリー内の異なる種類のノード (例: Dom\Element) を比較します。
75    // XML ドキュメントから <paragraph> 要素を取得します。
76    $paragraphElement = $dom->getElementsByTagName('paragraph')->item(0);
77
78    if ($paragraphElement instanceof Dom\Element) {
79        // エンティティノードと要素ノードは異なる種類のノードであり、DOMツリー上の位置も異なるため、false が返されます。
80        $isSameNode4 = $entityCompany1->isSameNode($paragraphElement);
81        echo "entityCompany1 と <paragraph> 要素は同じノードですか？ " . ($isSameNode4 ? "はい" : "いいえ") . "\n"; // 出力: いいえ
82    } else {
83        echo "エラー: <paragraph> 要素を取得できませんでした。\n";
84    }
85}
86
87// サンプルコードを実行します。
88demonstrateDomEntityIsSameNode();

Dom\Entity::isSameNode メソッドは、PHPのDOM操作において、2つのDOMノードがDOMツリー上で「完全に同じ実体」であるかを判定するために使用されます。

このメソッドは、引数として比較したい別のノードを?Dom\Node $otherNodeの形で受け取ります。この引数はDom\Node型のオブジェクト、またはnullを指定できます。メソッドが返す戻り値はbool型で、比較した2つのノードがDOMツリー内の同じノードを指していればtrueを、そうでなければfalseを返します。

主な用途としては、異なるPHPオブジェクトが、DOMツリー上の同じエンティティや要素などを参照しているかを確認する場面が挙げられます。例えば、サンプルコードのように同じエンティティ名を指定して複数回ノードを取得した場合、それらは異なるPHPオブジェクトになることがあっても、isSameNodeメソッドで比較するとtrueを返します。これは、どちらのオブジェクトもDOMツリー上の同じエンティティノードを指しているためです。

一方、異なるエンティティノード同士の比較や、エンティティノードと要素ノードといった種類の異なるノードとの比較ではfalseとなります。また、比較対象がnullの場合もfalseを返します。このメソッドにより、DOMツリー内のノードの一意性を確実に判断し、複雑なDOM操作における正確性を保つことができます。