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

isSameNodeメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年12月03日

基本的な使い方

isSameNodeメソッドは、DOMDocumentTypeノードが別のノードと同じであるかどうかを判定するメソッドです。具体的には、2つのノードが同じノードである、つまり同じオブジェクトを参照しているかどうかを比較します。ノードの値や属性が同じかどうかではなく、あくまでオブジェクトとしての同一性を検証します。

このメソッドは、DOMDocumentTypeクラスのインスタンスに対して呼び出され、引数として比較対象となるノードを受け取ります。比較対象のノードは、別のDOMDocumentTypeノードである必要はなく、DOMNodeインターフェースを実装した任意のノードを指定できます。

isSameNodeメソッドは、2つのノードが同じオブジェクトである場合にtrueを、そうでない場合にfalseを返します。このメソッドを利用することで、複雑なDOM構造の中で特定のノードが意図したノードと同一であるかどうかを効率的に確認できます。

例えば、DOM操作を行う際に、あるノードを別の場所に移動したり、複製したりする場合があります。その後、移動元または複製元のノードと、移動先または複製先のノードが本当に同じオブジェクトを指しているのかを確認するために、isSameNodeメソッドを使用することができます。これにより、予期せぬエラーを防ぎ、コードの信頼性を高めることができます。

isSameNodeメソッドは、特に大規模なDOM操作や、複数のスクリプトがDOMを共有する場合に、ノードの同一性を保証するために重要な役割を果たします。

構文(syntax)


1<?php
2namespace Dom;
3class DocumentType {
4    public function isSameNode(?\DOMNode $node): bool {}
5}
6?>

引数(parameters)

?Dom\Node $otherNode

?Dom\Node $otherNode: 比較対象のDom\Nodeインスタンス。nullを指定することも可能。

戻り値(return)

bool

このメソッドは、現在のノードと指定されたノードが同じノードであるかどうかを判定し、真偽値 (boolean) で返します。

サンプルコード

PHP Dom\DocumentType::isSameNodeでノード比較


1<?php
2
3// Dom\DocumentType::isSameNode メソッドのサンプルコード
4// PHP 8 以降で利用可能な Dom\Document 名前空間を使用します。
5
6/**
7 * 2つのDOMノードが同じノードであるかを比較し、結果を表示する関数。
8 *
9 * この関数は Dom\DocumentType::isSameNode メソッドの使用方法を示します。
10 * キーワード "php isnotempty" に関連付けて、比較対象のノードが
11 * 存在すること（nullでないこと）を確認するパターンも示します。
12 */
13function demonstrateDocumentTypeIsSameNode(): void
14{
15    echo "--- Dom\\DocumentType::isSameNode のデモンストレーション ---\n";
16
17    // 1. 最初のDOMドキュメントを作成し、HTMLをロードします。
18    //    <!DOCTYPE html> を含めることで、DocumentType ノードが確実に作成されます。
19    $dom1 = new Dom\Document();
20    $dom1->loadHTML('<!DOCTYPE html><html lang="ja"><head><title>DOM Test 1</title></head><body><h1>Hello 1</h1></body></html>');
21
22    // ドキュメントタイプノード1を取得します。
23    // Dom\Document::doctype は Dom\DocumentType オブジェクト、
24    // もしくは、DOCTYPEが定義されていない場合は null を返します。
25    $documentType1 = $dom1->doctype;
26
27    // $documentType1 が null でないことを確認します（"isnotempty" の概念）。
28    if ($documentType1 === null) {
29        echo "エラー: ドキュメントタイプノード1が見つかりませんでした。DOCTYPEが正しく含まれているか確認してください。\n";
30        return; // ノードがない場合はこれ以上処理できません
31    }
32
33    echo "現在のドキュメントには Dom\\DocumentType ノード1が存在します。\n"; // ノードが空でないことを確認
34
35    // 比較ケース1: 自分自身と同じノードと比較
36    echo "\n--- 比較ケース1: 自分自身と同じノードと比較 ---\n";
37    $isSameAsSelf = $documentType1->isSameNode($documentType1);
38    echo "documentType1 と documentType1 は同じノードか？ " . ($isSameAsSelf ? "はい (true)" : "いいえ (false)") . "\n";
39    // 結果は常に true になります。
40
41    // 比較ケース2: 別のDOMツリー内の Dom\DocumentType ノードと比較
42    // 新しいDOMを作成し、別のDocumentTypeを取得します。
43    $dom2 = new Dom\Document();
44    $dom2->loadHTML('<!DOCTYPE html><html lang="en"><head><title>DOM Test 2</title></head><body><h1>Hello 2</h1></body></html>');
45    $documentType2 = $dom2->doctype;
46
47    echo "\n--- 比較ケース2: 別のDOMツリー内の Dom\\DocumentType ノードと比較 ---\n";
48    // $documentType2 が null でないことを確認します（"isnotempty" の概念）。
49    if ($documentType2 !== null) {
50        echo "別のドキュメントには Dom\\DocumentType ノード2が存在します。\n"; // ノードが空でないことを確認
51        $isSameAsOtherDocType = $documentType1->isSameNode($documentType2);
52        echo "documentType1 と documentType2 は同じノードか？ " . ($isSameAsOtherDocType ? "はい (true)" : "いいえ (false)") . "\n";
53        // 別々のDOMツリーに属するノードなので、通常は false になります。
54    } else {
55        echo "別のドキュメントには Dom\\DocumentType ノード2が見つかりませんでした。\n";
56    }
57
58    // 比較ケース3: 同じDOMツリー内の別の種類のノード（例: HTML要素）と比較
59    // ドキュメント1から 'html' 要素ノードを取得します。
60    $htmlElement = $dom1->getElementsByTagName('html')->item(0);
61
62    echo "\n--- 比較ケース3: 同じDOMツリー内の別のノード (html要素) と比較 ---\n";
63    // $htmlElement が null でないことを確認します（"isnotempty" の概念）。
64    if ($htmlElement !== null) {
65        echo "HTML要素ノードは存在します。\n"; // ノードが空でないことを確認
66        $isSameAsHtmlElement = $documentType1->isSameNode($htmlElement);
67        echo "documentType1 と htmlElement は同じノードか？ " . ($isSameAsHtmlElement ? "はい (true)" : "いいえ (false)") . "\n";
68        // 異なる種類のノードなので、false になります。
69    } else {
70        echo "HTML要素ノードが見つかりませんでした。\n";
71    }
72
73    // 比較ケース4: null と比較 (isSameNode の引数は nullable なので可能)
74    echo "\n--- 比較ケース4: null と比較 ---\n";
75    $nullNode = null; // 比較対象として意図的に null を設定
76    echo "比較対象のノードが null です。これは 'empty' な状態を示します。\n";
77    $isSameAsNull = $documentType1->isSameNode($nullNode);
78    echo "documentType1 と nullNode は同じノードか？ " . ($isSameAsNull ? "はい (true)" : "いいえ (false)") . "\n";
79    // null は有効なノードではないため、常に false になります。
80
81    echo "\n--- デモンストレーション終了 ---\n";
82}
83
84// 関数を実行してデモンストレーションを開始します。
85demonstrateDocumentTypeIsSameNode();
86

Dom\DocumentType::isSameNode メソッドは、PHP 8で導入されたDOM操作のための機能です。このメソッドは、HTMLやXMLドキュメントの「<!DOCTYPE html>」といった宣言部分を表す Dom\DocumentType ノードが、引数として渡された別のDOMノードと物理的に同一のノードであるかを厳密に比較します。

具体的には、呼び出し元の Dom\DocumentType ノードが、引数で指定された ?Dom\Node $otherNode と同じメモリ上のインスタンスを指している場合に true を、そうでなければ false を真偽値（bool）として返します。引数には Dom\Node 型のオブジェクト、または null を渡すことが可能です。サンプルコードでは、「php isnotempty」の概念として、比較対象のノードが null でないことを事前に確認する安全な利用パターンを示しており、null と比較した場合は常に false となります。

例えば、自分自身と同じノードと比較した場合は true を返しますが、たとえ内容が同じであっても、異なるDOMツリーに属するノードや、同じDOMツリー内でも種類が異なるノード（例：HTML要素ノード）と比較した場合は false となります。このメソッドは、ノードの内容が同じかどうかではなく、メモリ上で同じオブジェクトを参照しているかという、オブジェクトとしての同一性を判断するために用いられ、DOMツリー内の特定のノードが重複していないか、あるいは参照が意図通りかを検証する際に役立ちます。

このサンプルコードは、Dom\DocumentType::isSameNodeメソッドが、二つのDOMノードがメモリ上でまったく同じノードインスタンスであるかを判定することを示しています。ノードの内容や構造が同じでも、異なるインスタンスであれば「同じ」とは判定されないことにご留意ください。特に、Dom\Document::doctypeプロパティはDOCTYPE宣言がない場合にnullを返す可能性があるため、メソッド呼び出し前には必ずnullチェックを行い、有効なノードが存在することを確認する習慣をつけましょう。これは「isnotempty」の考え方に基づき、ヌル参照エラーを防ぐために重要です。isSameNodeの引数にnullを渡すことも可能ですが、その場合は常にfalseを返します。異なるDOMツリーに属するノード同士や、異なる種類のノード同士は、内容が同じでも「同じ」とは判定されませんので、これらの特性を理解して安全にコードを利用してください。

PHP Dom\DocumentType::isSameNode でノード比較


1<?php
2
3/**
4 * Dom\DocumentType::isSameNode メソッドの動作を示すサンプルコードです。
5 *
6 * この関数は、2つの Dom\Node オブジェクトが厳密に同じノードであるかを
7 * 判定する isSameNode メソッドの挙動をデモンストレーションします。
8 * 特に Dom\DocumentType オブジェクトを対象とした例を示します。
9 *
10 * システムエンジニアを目指す初心者向けに、簡潔かつ明確な例を提供します。
11 */
12function demonstrateDomDocumentTypeIsSameNode(): void
13{
14    echo "--- Dom\\DocumentType::isSameNode のデモンストレーション ---\n\n";
15
16    // 1. 最初のDOMドキュメントとドキュメントタイプを準備します。
17    //    <!DOCTYPE html> を含むHTML文字列をロードすることで、Dom\DocumentType オブジェクトを簡単に取得できます。
18    $htmlContent1 = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html><body>Hello, PHP!</body></html>';
19    $dom1 = new Dom\Document();
20    // @ を付けて loadHTML が発行する可能性のある警告を抑制します。
21    // 本番環境ではエラーハンドリングを適切に行うべきです。
22    @$dom1->loadHTML($htmlContent1);
23
24    // ドキュメントから Dom\DocumentType オブジェクトを取得します。
25    $doctype1 = $dom1->doctype;
26
27    // ドキュメントタイプが取得できなかった場合のチェック
28    if ($doctype1 === null) {
29        echo "エラー: 最初のドキュメントから Dom\\DocumentType を取得できませんでした。\n";
30        echo "HTMLコンテンツに有効な <!DOCTYPE ...> 宣言が含まれているか確認してください。\n";
31        return;
32    }
33
34    echo "取得した最初のドキュメントタイプ (doctype1): " . $doctype1->name . "\n\n";
35
36    // 2. 同じドキュメントから再度ドキュメントタイプを取得し、自身と比較します。
37    //    isSameNode メソッドは、厳密に同じオブジェクトインスタンスであるかを判定します。
38    //    ここでは $doctype1 と $doctype1_same_ref は同じオブジェクトを参照します。
39    $doctype1_same_ref = $dom1->doctype;
40
41    echo "比較 1: ドキュメントタイプ (doctype1) と同じ参照を持つオブジェクトとの比較\n";
42    echo "期待される結果: true (厳密に同じインスタンスであるため)\n";
43    var_dump($doctype1->isSameNode($doctype1_same_ref));
44    echo "\n";
45
46    // 3. 別のDOMドキュメントを作成し、そこからドキュメントタイプを取得して比較します。
47    //    たとえ内容が同じ <!DOCTYPE ...> 宣言であっても、異なるドキュメントから取得された場合は
48    //    異なるオブジェクトと見なされます。
49    $htmlContent2 = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html><body>Hello, World!</body></html>';
50    $dom2 = new Dom\Document();
51    @$dom2->loadHTML($htmlContent2);
52
53    $doctype2 = $dom2->doctype;
54
55    echo "比較 2: ドキュメントタイプ (doctype1) と別のドキュメントのオブジェクト (doctype2) との比較\n";
56    echo "期待される結果: false (異なるインスタンスであるため)\n";
57    var_dump($doctype1->isSameNode($doctype2));
58    echo "\n";
59
60    // 4. null を引数に渡した場合の比較
61    //    isSameNode メソッドは、比較対象が null の場合は常に false を返します。
62    echo "比較 3: ドキュメントタイプ (doctype1) と null との比較\n";
63    echo "期待される結果: false (比較対象が null のため)\n";
64    var_dump($doctype1->isSameNode(null));
65    echo "\n";
66
67    // 5. 別の種類の Dom\Node (例: HTML要素ノード) との比較
68    //    Dom\DocumentType 以外のノードは、厳密には異なるノードとして扱われるため、false となります。
69    $elementNode = $dom1->createElement('div');
70    echo "比較 4: ドキュメントタイプ (doctype1) と別の種類の Dom\\Node (要素ノード) との比較\n";
71    echo "期待される結果: false (ノードの種類が異なるため)\n";
72    var_dump($doctype1->isSameNode($elementNode));
73    echo "\n";
74}
75
76// 上記の関数を実行して、Dom\DocumentType::isSameNode の動作をデモンストレーションします。
77demonstrateDomDocumentTypeIsSameNode();

Dom\DocumentType::isSameNodeメソッドは、PHPのDOM操作において、現在操作しているDom\DocumentTypeオブジェクトが、引数で指定された別のDom\Nodeオブジェクトと厳密に同じノードであるか（つまり、メモリ上で同じインスタンスを指しているか）を判定するために使用されます。

このメソッドは、引数として比較対象となるDom\Nodeオブジェクト、またはnullを受け取ります。戻り値は真偽値（bool）で、両者が厳密に同じノードであればtrueを、そうでなければfalseを返します。

具体的には、同じDom\Documentインスタンスから複数回doctypeプロパティにアクセスして得られたDom\DocumentTypeオブジェクト同士はtrueと判定されます。しかし、たとえ同じDOCTYPE宣言の内容を持つものでも、異なるDom\Documentインスタンスから作成されたDom\DocumentTypeオブジェクト同士は、異なるインスタンスであるためfalseと判定されます。また、引数にnullを渡した場合や、Dom\DocumentTypeとは異なる種類のDom\Node（例えば要素ノード）を渡した場合も、このメソッドは常にfalseを返します。この機能は、DOMツリー内の特定のノードを正確に識別する際に役立ちます。

Dom\DocumentType::isSameNodeメソッドは、二つのノードがメモリ上で厳密に同じオブジェクトインスタンスであるかを判定します。そのため、たとえ内容が同一であっても、異なるDom\Documentから取得されたノードは「同じではない」と判断されfalseを返します。引数にnullを渡した場合や、DocumentType以外の異なる種類のノードと比較した場合も同様にfalseとなりますのでご注意ください。サンプルコード中のDom\Document::loadHTMLメソッドでは、エラー抑制（@）を使用していますが、実運用では警告やエラーを適切に処理するエラーハンドリングを実装することが重要です。また、HTMLコンテンツにDOCTYPE宣言がない場合、doctypeプロパティはnullになるため、必ずnullチェックを行うようにしてください。