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

Copy
1<?php
2
3// DOMDocumentを生成
4$dom = new DOMDocument();
5
6// ルート要素を作成
7$root = $dom->createElement('root');
8$dom->appendChild($root);
9
10// 古い子要素を作成
11$oldChild = $dom->createElement('oldChild', 'This is the old child.');
12$root->appendChild($oldChild);
13
14// 新しい子要素を作成
15$newChild = $dom->createElement('newChild', 'This is the new child.');
16
17// 古い子要素を新しい子要素で置き換える
18$replacedChild = $root->replaceChild($newChild, $oldChild);
19
20// 結果を表示 (オプション)
21echo $dom->saveXML();
22
23?>

PHPのDOMElementクラスにおけるreplaceChildメソッドは、指定された子ノードを新しいノードで置き換えるために使用されます。このメソッドは、DOMツリー構造を操作する上で非常に重要です。

このメソッドはDOMNode $newChildとDOMNode $oldChildの2つの引数を取ります。$newChildは、置き換えに使用する新しいノードオブジェクトです。$oldChildは、置き換え対象となる既存のノードオブジェクトです。つまり、$oldChildを $newChildで置き換えます。

サンプルコードでは、まずDOMDocumentオブジェクトを生成し、ルート要素を作成しています。次に、oldChildという名前の古い子要素を作成し、ルート要素に追加します。同様に、newChildという名前の新しい子要素を作成します。

$root->replaceChild($newChild, $oldChild);の行が、replaceChildメソッドの実際の使用例です。この行は、ルート要素($root)の子要素である$oldChildを$newChildで置き換えます。

replaceChildメソッドは、置き換えられた古いノード（この例では$oldChild）を返り値として返します。サンプルコードでは、この返り値を$replacedChild変数に格納していますが、必須ではありません。

最後に、$dom->saveXML();で、DOMDocumentオブジェクト全体をXML形式で表示しています。これにより、oldChildがnewChildに置き換えられた結果を確認できます。このメソッドを使うことで、DOMドキュメント内の特定の子要素を動的に変更することが可能になり、XMLデータの操作が容易になります。

Copy
1<?php
2
3/**
4 * DOMElement::replaceChild メソッドの使用例
5 * 指定された親要素内の既存の子ノードを、新しい子ノードで置き換えます。
6 *
7 * システムエンジニアを目指す初心者向けに、簡単なHTML構造を作成し、
8 * その一部を置き換える手順を示します。
9 */
10
11// 1. DOMDocument オブジェクトを初期化します。
12//    '1.0' はXMLのバージョン、'UTF-8' はエンコーディングです。
13$dom = new DOMDocument('1.0', 'UTF-8');
14
15// 出力されるHTMLを整形するために設定します。
16$dom->formatOutput = true;
17
18// 2. HTMLの基本構造を作成します。
19$html = $dom->createElement('html');
20$dom->appendChild($html);
21
22$body = $dom->createElement('body');
23$html->appendChild($body);
24
25// 3. 親要素となる 'div' を作成し、bodyに追加します。
26$parentElement = $dom->createElement('div');
27$parentElement->setAttribute('id', 'container'); // id属性を設定
28$body->appendChild($parentElement);
29
30// 4. 置き換え対象となる「古い子ノード」を作成し、親要素に追加します。
31$oldChild = $dom->createElement('span', 'これは置き換えられる古いテキストです。');
32$oldChild->setAttribute('class', 'old-content');
33$parentElement->appendChild($oldChild);
34
35// 置き換えられない別の子ノードも追加しておき、動作を確認しやすくします。
36$siblingChild = $dom->createElement('p', 'これは隣にある別の段落です。');
37$parentElement->appendChild($siblingChild);
38
39// 5. 新しい子ノードを作成します。
40$newChild = $dom->createElement('strong', '新しいテキストで置き換えられました！');
41$newChild->setAttribute('class', 'new-content');
42
43echo "--- 置き換え前のHTML --- \n";
44// DOMDocument::saveHTML() で現在のDOM構造をHTML文字列として取得します。
45echo $dom->saveHTML();
46echo "\n";
47
48// 6. DOMElement::replaceChild() メソッドを呼び出し、ノードを置き換えます。
49//    引数: replaceChild(DOMNode $newChild, DOMNode $oldChild)
50//    戻り値: 削除された古いDOMNodeを返します。
51try {
52    $replacedNode = $parentElement->replaceChild($newChild, $oldChild);
53
54    echo "--- 置き換え後のHTML --- \n";
55    echo $dom->saveHTML();
56    echo "\n";
57
58    echo "削除されたノードのノード名: " . $replacedNode->nodeName . "\n";
59    echo "削除されたノードのノード値: " . $replacedNode->nodeValue . "\n";
60
61} catch (DOMException $e) {
62    // ノードが存在しない場合などにDOMExceptionが発生する可能性があります。
63    echo "エラーが発生しました: " . $e->getMessage() . "\n";
64}
65
66?>

DOMElement::replaceChildメソッドは、HTMLやXMLのようなツリー構造（DOM）をPHPで操作する際に、特定の親要素が持つ子ノードの一つを別の新しいノードに置き換えるために使用されます。

このサンプルコードでは、まずDOMDocumentオブジェクトを初期化し、HTMLの基本構造としてhtml、body、そしてid="container"を持つdivの親要素を順に作成しています。

次に、このdiv親要素の中に、置き換えの対象となる既存の「古い子ノード」としてspanタグと、動作確認のために置き換えられない「隣にある子ノード」としてpタグを追加しています。spanタグの内容は「これは置き換えられる古いテキストです。」と設定されています。

その後、「新しい子ノード」として、内容が「新しいテキストで置き換えられました！」というstrongタグを作成します。

replaceChildメソッドは、親要素である$parentElementに対して呼び出されます。このメソッドは二つのDOMNode型の引数を受け取ります。一つ目は新しく追加したいノードである$newChild（この例では$newChildのstrongタグ）、二つ目は置き換えたい既存のノードである$oldChild（この例では$oldChildのspanタグ）です。メソッドが実行されると、$oldChildはDOMツリーから削除され、その位置に$newChildが挿入されます。メソッドの戻り値は、DOMツリーから削除された$oldChildそのものです。これにより、削除されたノードの内容を後で確認したり、必要に応じて再利用したりすることが可能になります。

コードの実行結果として、replaceChildが呼ばれる前と後のHTML構造が出力され、spanタグがstrongタグに置き換わっていることが明確に確認できます。このように、replaceChildメソッドは、ウェブページのコンテンツを動的に更新する際に非常に重要な役割を果たします。