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

Copy
1<?php
2
3/**
4 * DOMDocumentを使用して、指定した子ノードを新しいノードに置き換えるサンプル関数
5 *
6 * このコードは、XMLドキュメント内の特定の要素の子ノードを
7 * replaceChild() メソッドを使って新しい要素に置き換える方法を示します。
8 */
9function demonstrateReplaceChild(): void
10{
11    // 操作対象のXML文字列を定義
12    $xmlString = <<<XML
13<?xml version="1.0" encoding="UTF-8"?>
14<bookstore>
15  <book category="cooking">
16    <title lang="en">Everyday Italian</title>
17    <author>Giada De Laurentiis</author>
18    <year>2005</year>
19  </book>
20  <book category="children">
21    <title lang="en">Harry Potter</title>
22    <author>J.K. Rowling</author>
23    <year>2005</year>
24  </book>
25</bookstore>
26XML;
27
28    // DOMDocumentオブジェクトを作成
29    $doc = new DOMDocument();
30    // XML文字列を読み込み、構造を整形して出力するように設定
31    $doc->preserveWhiteSpace = false;
32    $doc->formatOutput = true;
33    $doc->loadXML($xmlString);
34
35    // 親となる要素 (最初の <book> 要素) を取得
36    $bookElement = $doc->getElementsByTagName('book')->item(0);
37    if ($bookElement === null) {
38        echo "対象のbook要素が見つかりませんでした。\n";
39        return;
40    }
41
42    // 置き換え対象となる子ノード (<author> 要素) を取得
43    $oldChild = $bookElement->getElementsByTagName('author')->item(0);
44    if ($oldChild === null) {
45        echo "対象のauthor要素が見つかりませんでした。\n";
46        return;
47    }
48
49    // 新しく挿入するノード (<editor> 要素) を作成
50    $newChild = $doc->createElement('editor', 'John Doe');
51
52    echo "--- 変更前のXML ---\n";
53    echo $doc->saveXML();
54    echo "\n";
55
56    // replaceChild() を使って <author> を <editor> に置き換える
57    // 第1引数: 新しいノード
58    // 第2引数: 置き換える既存の子ノード
59    $replacedNode = $bookElement->replaceChild($newChild, $oldChild);
60
61    // 戻り値は置き換えられた古いノード
62    if ($replacedNode) {
63        echo "--- 変更後のXML ---\n";
64        echo $doc->saveXML();
65    } else {
66        echo "ノードの置換に失敗しました。\n";
67    }
68}
69
70// 関数を実行
71demonstrateReplaceChild();

PHPのreplaceChild()は、DOMドキュメント内の特定の子ノードを、新しく作成したノードに置き換えるためのメソッドです。この機能により、XMLやHTMLの構造を動的に変更できます。

サンプルコードでは、まずDOMDocumentオブジェクトを生成し、XML文字列を読み込んでいます。次に、getElementsByTagName()を使って、親要素である最初の<book>要素と、その子要素である<author>要素を取得します。同時に、createElement()で置き換え後に追加したい新しい<editor>要素を作成しています。

$bookElement->replaceChild($newChild, $oldChild)という部分がこのメソッドの核心です。第1引数には新しく挿入するノード（<editor>）、第2引数には置き換え対象となる既存の子ノード（<author>）を指定します。この処理により、<book>要素内の<author>要素が<editor>要素に置き換えられます。

このメソッドの戻り値は、置き換えられて削除された古いノード、つまりサンプルコードにおける<author>要素です。処理が成功すると、この古いノードが返されるため、必要であれば後続の処理で利用することも可能です。もし置き換えに失敗した場合は、エラーが発生します。

Copy
1<?php
2
3/**
4 * DOMDocument を使用して、指定した子ノードを新しいノードに置き換えるサンプル関数です。
5 */
6function replaceChildExample(): void
7{
8    // XML文字列を定義します。
9    $xmlString = <<<XML
10<?xml version="1.0" encoding="UTF-8"?>
11<root>
12  <item>
13    <title>古いタイトル</title>
14    <author>著者A</author>
15  </item>
16</root>
17XML;
18
19    // DOMDocumentオブジェクトを生成し、XMLを読み込みます。
20    $dom = new \DOMDocument('1.0', 'UTF-8');
21    // 出力を整形するために true を設定します。
22    $dom->formatOutput = true;
23    $dom->loadXML($xmlString);
24
25    // 親ノード <item> を取得します。
26    $itemNode = $dom->getElementsByTagName('item')->item(0);
27    if (!$itemNode) {
28        echo 'Error: <item> node not found.';
29        return;
30    }
31
32    // 置換対象となる古い子ノード <title> を取得します。
33    $oldChild = $itemNode->getElementsByTagName('title')->item(0);
34    if (!$oldChild) {
35        echo 'Error: <title> node not found.';
36        return;
37    }
38
39    // 新しい子ノード <title> を作成します。
40    $newChild = $dom->createElement('title', '新しいタイトル');
41
42    // 親ノードの replaceChild メソッドを呼び出し、古いノードを新しいノードに置き換えます。
43    // このメソッドは、置き換えられて削除された古いノードを返します。
44    $replacedNode = $itemNode->replaceChild($newChild, $oldChild);
45
46    // --- 結果の表示 ---
47
48    echo "--- 置換前のXML ---\n";
49    echo $xmlString . "\n\n";
50    
51    echo "--- 置換後のXML ---\n";
52    // saveXML() でドキュメント全体を文字列として取得し、出力します。
53    echo $dom->saveXML();
54
55    echo "--- 置き換えられたノード ---\n";
56    // saveXML() に引数を渡すことで、特定のノードのXML文字列を取得できます。
57    echo "タグ名: " . $replacedNode->nodeName . "\n";
58    echo "内容: " . $replacedNode->nodeValue . "\n";
59}
60
61// 関数を実行します。
62replaceChildExample();
63
64?>

PHPのreplaceChildメソッドは、DOMドキュメントにおいて、指定した親ノードが持つ子ノードを、別の新しいノードに置き換えるために使用します。

サンプルコードでは、まずXML文字列をDOMDocumentオブジェクトとして読み込み、操作可能な状態にしています。次に、親ノードである<item>要素と、その中に含まれる置換対象の古い<title>要素をそれぞれ取得します。そしてcreateElementメソッドを使い、置き換えたい内容を持つ新しい<title>要素を作成しています。

コードの中心となる$itemNode->replaceChild($newChild, $oldChild)の呼び出し部分を見てみましょう。このメソッドの第1引数には新しく挿入したいノード、第2引数には置き換えたい既存の子ノードを指定します。この処理により、親ノード<item>の中から古い<title>が削除され、その場所に新しい<title>が挿入されます。

また、replaceChildメソッドは戻り値として、置き換えられて削除された古いノードを返します。サンプルでは、変数$replacedNodeでこのノードを受け取り、後でその内容を確認しています。このように、このメソッドを使うことでXMLやHTMLの構造を動的に変更することが可能です。