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

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

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

基本的な使い方

cloneNodeメソッドは、PHPのDOM拡張機能に属するDOMDocumentTypeクラスにおいて、現在のドキュメント型宣言ノードを複製するために使用されるメソッドです。このメソッドは、呼び出し元のDOMDocumentTypeオブジェクトと全く同じ名前、パブリックID、システムIDなどの属性や値を保持する新しいDOMDocumentTypeオブジェクトを生成し、返します。

このメソッドはオプションでブール型の$deep引数を受け取ります。$deepにtrueを指定すると、通常はノードの全ての子ノードも再帰的に複製されます。しかし、DOMDocumentTypeノードは通常、子ノードを持つことがありません。そのため、$deepにtrueを指定した場合でもfalseを指定した場合でも、複製されるのはDOMDocumentTypeノード自身のみとなり、その挙動に実質的な違いはありません。

複製された新しいDOMDocumentTypeノードは、元のノードとは完全に独立したオブジェクトです。この新しいノードは、元のノードが属していたドキュメントツリーには関連付けられておらず、親ノードも持ちません。したがって、複製したノードを別のドキュメントや既存のドキュメントの異なる位置に追加したい場合は、明示的にそのドキュメントへの追加操作を行う必要があります。この機能を利用することで、既存のドキュメント型宣言の構造を基に、新しいドキュメント型宣言のオブジェクトを柔軟に作成できます。

構文(syntax)


1public DOMNode DOMDocumentType::cloneNode(bool $deep = false)

引数(parameters)

?bool $deep = false

bool $deep = false: trueを指定すると、ノードとそのすべての子孫ノードを複製します。falseを指定すると、ノードのみを複製します。

戻り値(return)

DOMNode

DOMDocumentType::cloneNodeメソッドは、指定されたノードのディープコピーを返します。

サンプルコード

PHP: DOMDocumentTypeのcloneNodeでノードを複製する


1<?php
2
3// DOMDocumentオブジェクトを作成し、HTMLコンテンツを読み込みます。
4// これはHTMLやXMLドキュメントをPHPで操作するための基盤となります。
5$dom = new DOMDocument();
6// HTML5のDOCTYPE宣言を含む簡単なHTML文字列。
7// cloneNodeメソッドは、このDOCTYPEノードを複製する際に使用されます。
8$htmlContent = '<!DOCTYPE html><html><head><title>Test</title></head><body><h1>Hello</h1></body></html>';
9$dom->loadHTML($htmlContent);
10
11// DOMDocumentのdoctypeプロパティからDOMDocumentTypeノードを取得します。
12// このノードは、ドキュメントのDOCTYPE宣言（例: <!DOCTYPE html>）を表します。
13$originalDoctype = $dom->doctype;
14
15if ($originalDoctype instanceof DOMDocumentType) {
16    echo "--- 元のDOMDocumentTypeノードの情報 ---\n";
17    echo "ノード名 (nodeName): " . $originalDoctype->nodeName . "\n";
18    // DOMDocumentTypeノードのnodeValueは通常空文字列です。
19    echo "ノード値 (nodeValue): '" . $originalDoctype->nodeValue . "'\n";
20    echo "パブリックID (publicId): '" . $originalDoctype->publicId . "'\n";
21    echo "システムID (systemId): '" . $originalDoctype->systemId . "'\n";
22    // オブジェクトのユニークな識別子 (ハッシュ) を出力し、
23    // 後で複製されたオブジェクトと比較して、別物であることを確認します。
24    echo "オブジェクトハッシュ (元): " . spl_object_hash($originalDoctype) . "\n\n";
25
26    // cloneNodeメソッドを使用してDOMDocumentTypeノードを複製します。
27    // 引数 $deep は、ノードの子孫ノードも複製するかどうかを制御します。
28    // DOMDocumentTypeノードは子ノードを持たないため、$deepの値（true/false）は結果に影響しません。
29    // ここではデフォルト値の false を明示的に指定しています。
30    $clonedDoctype = $originalDoctype->cloneNode(false);
31
32    echo "--- 複製されたDOMDocumentTypeノードの情報 ---\n";
33    echo "ノード名 (nodeName): " . $clonedDoctype->nodeName . "\n";
34    echo "ノード値 (nodeValue): '" . $clonedDoctype->nodeValue . "'\n";
35    echo "パブリックID (publicId): '" . $clonedDoctype->publicId . "'\n";
36    echo "システムID (systemId): '" . $clonedDoctype->systemId . "'\n";
37    // 複製されたオブジェクトのハッシュ値を出力し、元のノードと異なることを確認します。
38    echo "オブジェクトハッシュ (複製): " . spl_object_hash($clonedDoctype) . "\n\n";
39
40    // 元のノードと複製されたノードが異なるオブジェクトインスタンスであることを確認します。
41    // === 演算子は、値と型が等しいか、かつ同じオブジェクトであるかをチェックします。
42    // cloneNodeは新しいオブジェクトを返すため、これらは異なるオブジェクトになります。
43    if ($originalDoctype !== $clonedDoctype) {
44        echo "確認: 元のDOMDocumentTypeノードと複製されたノードは、異なるオブジェクトインスタンスです。\n";
45        echo "cloneNodeメソッドは、指定されたノードのコピーを生成します。\n";
46    } else {
47        echo "エラー: 元のDOMDocumentTypeノードと複製されたノードが同じオブジェクトです (予期しない動作)。\n";
48    }
49
50} else {
51    echo "DOMDocumentTypeノードが見つかりませんでした。\n";
52    echo "指定されたHTMLコンテンツにDOCTYPE宣言がないか、パースに失敗しました。\n";
53}
54
55?>

PHP 8のDOMDocumentType::cloneNodeメソッドは、HTMLやXMLドキュメントにおけるDOCTYPE宣言（例: <!DOCTYPE html>)を表すDOMDocumentTypeノードを複製するために使用されます。このメソッドは、呼び出し元のDOMDocumentTypeノードと全く同じ内容を持つ、新しいDOMNodeオブジェクトを作成します。これにより、元のノードとは異なる独立したオブジェクトインスタンスが生成され、メモリ上も分離されます。

引数?bool $deep = falseはオプションで、デフォルトはfalseです。通常、この引数はノードの子孫ノードも複製するかどうかを決定しますが、DOMDocumentTypeノード自体は子ノードを持たないため、$deepの値をtrueにしてもfalseにしても複製結果に違いはありません。

戻り値は、複製された新しいDOMNodeオブジェクトです。これは、元のノードの宣言情報（ノード名、パブリックID、システムIDなど）を完全に引き継いだコピーとなります。PHPでHTMLやXMLドキュメントの構造を操作する際に、既存のDOCTYPE宣言の情報を変更せずに再利用したり、他のドキュメントに適用したりしたい場合に、このcloneNodeメソッドが安全かつ効率的な方法を提供します。

DOMDocumentType::cloneNodeメソッドは、現在のノードの完全に独立したコピーを生成します。元のノードとは異なる新しいオブジェクトインスタンスが作成されるため、元のノードに変更を加えても複製されたノードには影響しません。サンプルコードでは、spl_object_hash関数や!==演算子を使って、元と複製されたノードが別々のオブジェクトであることを確認しています。

引数$deepは子ノードも複製するかどうかを制御しますが、DOMDocumentTypeノードは子ノードを持たないため、この引数の値が結果に影響することはありません。しかし、他の種類のDOMノードを複製する際には$deepの指定が重要となるため、注意が必要です。DOMDocumentTypeノードのnodeValueプロパティは通常空文字列となります。

PHP cloneNodeでDOMDocumentTypeを複製する


1<?php
2
3// DOMDocumentType::cloneNode メソッドのサンプルコード
4// このメソッドは、既存の DOMDocumentType ノードを複製します。
5// システムエンジニアを目指す初心者にも分かりやすいように、具体的な使用例を示します。
6
7// 1. 新しい DOMDocument オブジェクトを作成します。
8//    これはXMLやHTMLドキュメントを扱うための基盤となります。
9$dom = new DOMDocument();
10
11// 2. DOCTYPE 宣言を含むXML文字列をロードします。
12//    ここでは XHTML 1.0 Strict の DOCTYPE を含む簡単なXMLを使用します。
13$xmlString = '
14<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
15<html>
16<head></head>
17<body></body>
18</html>
19';
20$dom->loadXML($xmlString);
21
22// 3. ドキュメントから DOMDocumentType ノードを取得します。
23//    DOMDocument::$doctype プロパティは、ドキュメントのDOCTYPEノードを返します。
24$originalDocType = $dom->doctype;
25
26// DOMDocumentType ノードが正常に取得できたことを確認します。
27if ($originalDocType instanceof DOMDocumentType) {
28    echo "--- 元の DOMDocumentType ノード ---\n";
29    echo "ノード名: " . $originalDocType->nodeName . "\n";
30    echo "公開識別子 (publicId): " . $originalDocType->publicId . "\n";
31    echo "システム識別子 (systemId): " . $originalDocType->systemId . "\n";
32    echo "オブジェクトID: " . spl_object_id($originalDocType) . " (メモリ上のユニークな識別子)\n\n";
33
34    // 4. cloneNode() メソッドを使って DOMDocumentType ノードを複製します。
35    //    DOMDocumentType ノードは子ノードを持たないため、引数 `$deep` の値は結果に影響しません。
36    //    デフォルト値は `false` です。
37    $clonedDocType = $originalDocType->cloneNode();
38
39    echo "--- クローンされた DOMDocumentType ノード ---\n";
40    echo "ノード名: " . $clonedDocType->nodeName . "\n";
41    echo "公開識別子 (publicId): " . $clonedDocType->publicId . "\n";
42    echo "システム識別子 (systemId): " . $clonedDocType->systemId . "\n";
43    echo "オブジェクトID: " . spl_object_id($clonedDocType) . "\n\n";
44
45    // 5. 元のノードとクローンされたノードの比較を行います。
46
47    // オブジェクトそのものが異なるかを確認 (参照が異なるか)
48    echo "元のノードとクローンされたノードは同じオブジェクトですか？: ";
49    echo ($originalDocType === $clonedDocType ? "はい" : "いいえ") . "\n";
50    // 結果: いいえ (異なるオブジェクトが作成されます)
51
52    // ノードの内容 (プロパティ) が同じかを確認
53    echo "元のノードとクローンされたノードの内容は同じですか？: ";
54    echo ($originalDocType->nodeName === $clonedDocType->nodeName &&
55          $originalDocType->publicId === $clonedDocType->publicId &&
56          $originalDocType->systemId === $clonedDocType->systemId ? "はい" : "いいえ") . "\n";
57    // 結果: はい (内容は複製されているため同じです)
58
59} else {
60    echo "エラー: DOMDocumentType ノードが見つかりませんでした。提供されたXML文字列にDOCTYPE宣言が含まれているか確認してください。\n";
61}
62

DOMDocumentType::cloneNodeメソッドは、XMLやHTMLドキュメントのDOCTYPE宣言を表すDOMDocumentTypeノードを複製するために使用されます。このメソッドを呼び出すと、元のノードと全く同じ内容を持つ、しかしメモリ上では別の新しいDOMDocumentTypeオブジェクトが作成され、戻り値として返されます。

サンプルコードでは、最初にDOCTYPE宣言を含むXML文字列をDOMDocumentオブジェクトにロードし、そのドキュメントから$dom->doctypeプロパティを使って元のDOMDocumentTypeノードを取得しています。次に、この取得したノードに対してcloneNode()を呼び出すことで、新しい複製ノードを得ています。

cloneNodeメソッドには$deepというブール型の引数がありますが、DOMDocumentTypeノードは子ノードを持たないため、この引数にtrueを設定してもfalse（デフォルト値）を設定しても、複製結果に違いはありません。複製されたノードは、元のノードと同じノード名、公開識別子、システム識別子といったプロパティを持ちますが、spl_object_idで確認できるように、メモリ上では異なるオブジェクトとして生成されます。この機能は、既存のDOCTYPE情報を再利用し、新しいドキュメントや異なる文脈で活用したい場合に役立ちます。

cloneNode()メソッドは、元のDOMDocumentTypeノードの内容をコピーした全く新しいオブジェクトを生成します。これは元のノードとは異なる参照を持つため、元のノードの変更は複製されたノードには影響しません。DOMDocumentTypeノードは子ノードを持たない特性から、cloneNode()メソッドの$deep引数をtrueまたはfalseのどちらに設定しても、複製結果に違いはありません。ドキュメントにDOCTYPE宣言が含まれていない場合、$dom->doctypeはnullを返しますので、必ずメソッド呼び出し前にノードが存在するかどうかを確認する処理を含めてください。複製されたノードは、ドキュメントツリーには自動で追加されません。必要に応じてDOMDocumentの適切なメソッドでツリーに組み込む必要があります。