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

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

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

基本的な使い方

cloneNodeメソッドは、Dom\DocumentTypeクラスのインスタンス（DocumentTypeノード）の複製を作成するメソッドです。DocumentTypeノードは、XMLドキュメントのDTD（Document Type Definition）を定義するもので、DOCTYPE宣言を表します。

このメソッドは、引数として渡されたdeepパラメータの値に応じて、ノードの浅いコピーまたは深いコピーを作成します。deepパラメータがtrueの場合、DocumentTypeノードとそのすべての子孫ノードが複製されます。falseの場合、DocumentTypeノードのみが複製され、子孫ノードは複製されません。ただし、DocumentTypeノードには通常、子ノードは存在しないため、deepパラメータの値に関わらず、結果は基本的に同じになります。

cloneNodeメソッドは、元のDocumentTypeノードを変更せず、新しいDocumentTypeノードを返します。複製されたノードは、まだドキュメントツリーに挿入されていません。複製されたノードをドキュメントツリーに追加するには、appendChildメソッドやinsertBeforeメソッドなどのノード操作メソッドを使用する必要があります。

このメソッドは、例えば、既存のDocumentTypeノードの情報を基に、新しいXMLドキュメントを作成する場合などに役立ちます。また、DocumentTypeノードの情報を一時的に保存し、後で使用する場合にも利用できます。cloneNodeメソッドを使用することで、既存のノードを直接変更することなく、新しいノードを作成できるため、安全なノード操作が可能になります。

構文(syntax)


1Dom\DocumentType::cloneNode( ?bool $deep = null ): Dom\Node

引数(parameters)

bool $deep = false

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

戻り値(return)

Dom\Node

Dom\Node クラスのインスタンスを返します。これは、元の Dom\DocumentType ノードのディープコピー、つまり、ノードとそのすべての子孫ノードの複製です。

サンプルコード

PHP Dom\DocumentType::cloneNode() でノードを複製する


1<?php
2
3/**
4 * Dom\DocumentType::cloneNode() メソッドの使用例を示します。
5 *
6 * この関数は、指定されたDom\DocumentTypeノードを複製し、
7 * その特性を出力することで、クローン処理の動作を説明します。
8 * システムエンジニアを目指す初心者向けに、簡潔で分かりやすいコードを提供します。
9 */
10function demonstrateDomDocumentTypeCloneNode(): void
11{
12    // 1. 新しい Dom\Document オブジェクトを作成します。
13    $dom = new Dom\Document();
14
15    // 2. ドキュメントタイプノードをドキュメントに追加します。
16    //    Dom\DocumentType を直接インスタンス化することはできないため、
17    //    Dom\Document::createDocumentType() を使用して作成し、ドキュメントに追加します。
18    //    ここではHTML5のシンプルなDOCTYPEを作成します。
19    $dom->appendChild($dom->createDocumentType('html'));
20
21    // 3. ドキュメントから追加した Dom\DocumentType ノードを取得します。
22    $originalDoctype = $dom->doctype;
23
24    // ノードが正しく作成されたかを確認
25    if (!$originalDoctype instanceof Dom\DocumentType) {
26        echo "エラー: Dom\\DocumentType ノードの作成または取得に失敗しました。" . PHP_EOL;
27        return;
28    }
29
30    echo "=== Dom\\DocumentType::cloneNode() の使用例 ===" . PHP_EOL . PHP_EOL;
31
32    // 元の Dom\DocumentType ノードの情報を表示
33    echo "--- 元の Dom\\DocumentType ノード ---" . PHP_EOL;
34    echo "名前: " . $originalDoctype->name . PHP_EOL;
35    echo "ノードの種類: " . $originalDoctype->nodeType . " (Dom\\Node::DOCUMENT_TYPE_NODE)" . PHP_EOL;
36    echo "システムID: " . ($originalDoctype->systemId ?: 'なし') . PHP_EOL; // HTML5 DOCTYPEは通常、IDを持ちません
37    echo "公開ID: " . ($originalDoctype->publicId ?: 'なし') . PHP_EOL;   // HTML5 DOCTYPEは通常、IDを持ちません
38    echo "-----------------------------------" . PHP_EOL . PHP_EOL;
39
40    // 4. cloneNode() メソッドを使用してドキュメントタイプノードをクローンします。
41    //    引数 $deep は、子ノードも再帰的にクローンするかどうかを決定します。
42    //    しかし、Dom\DocumentType ノードは子ノードを持たないため、$deep の値 (true/false) は
43    //    このノードのクローン処理において実質的な違いを生み出しません。
44    $clonedDoctype = $originalDoctype->cloneNode(false); // $deep は false でも true でも、このノードでは同じ結果になります
45
46    // クローンされた Dom\DocumentType ノードの情報を表示
47    echo "--- クローンされた Dom\\DocumentType ノード ---" . PHP_EOL;
48    echo "名前: " . $clonedDoctype->name . PHP_EOL;
49    echo "ノードの種類: " . $clonedDoctype->nodeType . " (Dom\\Node::DOCUMENT_TYPE_NODE)" . PHP_EOL;
50    echo "システムID: " . ($clonedDoctype->systemId ?: 'なし') . PHP_EOL;
51    echo "公開ID: " . ($clonedDoctype->publicId ?: 'なし') . PHP_EOL;
52    // 元のノードとクローンされたノードが異なるオブジェクトであることを確認
53    echo "元のノードと同一オブジェクトか (===): " . ($originalDoctype === $clonedDoctype ? 'はい' : 'いいえ') . PHP_EOL;
54    echo "（Domノードのクローンは常に新しい独立したオブジェクトを生成します）" . PHP_EOL;
55    echo "--------------------------------------------------" . PHP_EOL;
56}
57
58// 関数を実行して、Dom\DocumentType::cloneNode() の動作を確認します。
59demonstrateDomDocumentTypeCloneNode();

PHPのDom\DocumentType::cloneNode()メソッドは、既存のDom\DocumentTypeノードを正確に複製するために使用されます。このメソッドは、指定されたDom\DocumentTypeノードのコピーを作成し、新しい独立したDom\Nodeオブジェクトとして返します。

引数$deepは真偽値を取り、通常は子ノードも再帰的に複製するかどうかを制御します。しかし、Dom\DocumentTypeノードは子ノードを持たないため、この引数の値をtrueにしてもfalseにしても、このノードのクローン処理においては結果に実質的な違いは生じません。戻り値は、複製されたノードであるDom\Nodeオブジェクトです。これは元のノードとは完全に別個のインスタンスとなります。

サンプルコードでは、まず新しいDom\Documentオブジェクト内にシンプルなHTML5のドキュメントタイプノードを作成し、それを$originalDoctypeとして取得しています。次に、$originalDoctype->cloneNode(false)を呼び出すことで、このドキュメントタイプノードの複製を作成し、$clonedDoctypeに格納します。その後、元のノードと複製されたノードそれぞれの名前やノードの種類といったプロパティを出力し、両者が異なるオブジェクトであることを===演算子を使って確認します。これにより、cloneNodeが元のオブジェクトとは独立した新しいオブジェクトを生成する「php clone」の動作を具体的に示しています。

Dom\DocumentTypeノードは、直接newでインスタンス化することはできず、Dom\Document::createDocumentType()メソッドを使って生成し、ドキュメントにappendChild()で追加して利用します。cloneNode()メソッドは、元のノードとは完全に独立した新しいオブジェクトを生成しますので、元のノードとクローンされたノードが同一であるかどうかを比較する===演算子は常にfalseとなります。また、Dom\DocumentTypeノードは子ノードを持たないため、cloneNode()メソッドの引数$deepにtrueまたはfalseのどちらを指定しても、クローン結果に実質的な違いはありません。この挙動は、子ノードを持つ他のDOMノードをクローンする場合と異なるため特に注意が必要です。クローンされたノードは元のドキュメントには自動的に追加されないため、必要に応じてappendChild()などのメソッドで明示的に追加する必要があります。

PHP Dom\DocumentType cloneNode で複製する


1<?php
2
3// システムエンジニアを目指す初心者向け
4// PHPのDOM拡張機能におけるDocumentTypeノードのクローン（複製）方法を示すサンプルコードです。
5// Dom\DocumentType::cloneNode() メソッドは、指定されたDocumentTypeノードのコピーを作成します。
6
7// 1. 新しいDom\Documentオブジェクトを作成します。
8//    このオブジェクトはXMLやHTMLの構造をメモリ上で表現するために使われます。
9$dom = new Dom\Document();
10
11// 2. DTD（Document Type Definition）を含むXML文字列をロードします。
12//    Dom\DocumentTypeオブジェクトを取得するためには、DTDが定義されている必要があります。
13$xmlString = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html/>';
14$dom->loadXML($xmlString);
15
16// 3. ロードされたドキュメントからDom\DocumentTypeオブジェクトを取得します。
17//    $dom->doctype プロパティは、ドキュメントのDocumentTypeノードを返します。
18$originalDoctype = $dom->doctype;
19
20// DocumentTypeが正しく取得できたか確認します。
21if ($originalDoctype instanceof Dom\DocumentType) {
22    echo "--- 元の DocumentType の情報 ---\n";
23    echo "名前: " . $originalDoctype->name . "\n";
24    echo "公開識別子 (publicId): " . $originalDoctype->publicId . "\n";
25    echo "システム識別子 (systemId): " . $originalDoctype->systemId . "\n";
26    echo "ノードタイプ: " . $originalDoctype->nodeType . " (DOM_DOCUMENT_TYPE_NODE)\n\n";
27
28    // 4. cloneNode() メソッドを使用して、DocumentTypeノードをクローン（複製）します。
29    //    Dom\DocumentTypeノードは子ノードを持たないため、$deep引数（深いクローンを行うかどうか）
30    //    は、この文脈では結果に影響を与えません。ここでは明示的にtrueを指定します。
31    $clonedDoctype = $originalDoctype->cloneNode(true);
32
33    echo "--- クローンされた DocumentType の情報 ---\n";
34    echo "名前: " . $clonedDoctype->name . "\n";
35    echo "公開識別子 (publicId): " . $clonedDoctype->publicId . "\n";
36    echo "システム識別子 (systemId): " . $clonedDoctype->systemId . "\n";
37    echo "ノードタイプ: " . $clonedDoctype->nodeType . " (DOM_DOCUMENT_TYPE_NODE)\n\n";
38
39    // 5. 元のノードとクローンされたノードが異なるオブジェクトであることを確認します。
40    //    cloneNode() は新しいオブジェクトを作成するため、これらは通常異なるインスタンスになります。
41    if ($originalDoctype !== $clonedDoctype) {
42        echo "結果: 元のDocumentTypeとクローンされたDocumentTypeは異なるオブジェクトです。\n";
43    } else {
44        echo "結果: 元のDocumentTypeとクローンされたDocumentTypeは同じオブジェクトです。(これは通常発生しません)\n";
45    }
46
47} else {
48    echo "エラー: ドキュメントにDocumentTypeノードが見つかりませんでした。\n";
49    echo "         DTDがXML文字列に正しく含まれているか確認してください。\n";
50}
51

PHPのDOM拡張機能は、XMLやHTMLドキュメントの構造をプログラムで操作するための機能を提供します。その中で、Dom\DocumentTypeクラスは、ドキュメントの型定義（DOCTYPE）情報を表すノードです。Dom\DocumentType::cloneNode()メソッドは、指定されたDom\DocumentTypeノードを複製し、元のノードと全く同じ内容を持つ新しいノードを作成します。

このメソッドの引数$deepは、通常、子ノードも再帰的に複製するかどうかを決定しますが、Dom\DocumentTypeノードは子ノードを持たないため、この引数をtrueまたはfalseのどちらに設定しても、複製されるDocumentTypeノードの内容に違いはありません。メソッドの戻り値は、複製された新しいDom\DocumentTypeオブジェクト（Dom\Node型として返されます）です。このとき、元のノードとは別の新しいオブジェクトがメモリ上に生成されるため、元のノードと複製されたノードは異なるインスタンスとなります。これにより、既存のDOCTYPE情報を基に新しいノードを作成し、元の情報を保護しながら独立して操作することが可能になります。

cloneNode()メソッドは、元のノードとは独立した新しいオブジェクトを生成します。元のノードへの変更がクローンに影響しないため、それぞれを独立して扱えます。

Dom\DocumentTypeは子ノードを持たないため、cloneNode()の$deep引数（子ノードも複製するかどうか）は結果に影響しません。しかし、他のDOMノードを複製する際には、子ノードの複製有無を制御する重要な引数となるため、その役割を理解してください。

Dom\DocumentTypeオブジェクトは、DTD（文書型定義）が定義されたXMLまたはHTMLをDom\Documentにロードした場合にのみ取得可能です。DTDがないと$dom->doctypeはnullとなるため、必ずオブジェクトの存在確認は必須です。