【PHP8.x】replaceChildメソッドの使い方

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::replaceChild の使用例を示します。
5 * この関数は、指定されたXMLドキュメント内で既存の子ノードを新しいノードに置き換えます。
6 *
7 * PHP 8の新しい Dom\XMLDocument クラス（以前の DOMDocument と同等）を使用しています。
8 */
9function demonstrateDomReplaceChild(): void
10{
11    // 1. Dom\XMLDocument オブジェクトを初期化します。
12    // XMLを読み込むためのコンテナを作成します。
13    $document = new Dom\XMLDocument('1.0', 'UTF-8');
14    $document->preserveWhiteSpace = false; // 整形のために空白ノードを無視
15    $document->formatOutput = true;       // 出力を整形
16
17    // 2. 初期XMLコンテンツを読み込みます。
18    // <root>要素内に、置き換え対象となる <item id="old"> ノードを含めます。
19    $initialXml = <<<XML
20<root>
21    <item id="old">これは古い要素です。</item>
22    <item id="2">これは別の要素です。</item>
23</root>
24XML;
25    $document->loadXML($initialXml);
26
27    echo "--- 初期XMLドキュメント ---\n";
28    echo $document->saveXML();
29    echo "\n";
30
31    // 3. 置き換える対象の 'oldChild' ノードを見つけます。
32    // XPathを使用して、idが"old"の<item>要素を取得します。
33    $xpath = new Dom\XPath($document);
34    $oldChildNodes = $xpath->query('//item[@id="old"]');
35
36    if ($oldChildNodes->count() === 0) {
37        echo "エラー: 置き換え対象のノードが見つかりませんでした。\n";
38        return;
39    }
40
41    $oldChild = $oldChildNodes[0]; // 最初のマッチしたノードを取得
42
43    // 4. 新しいノード 'newChild' を作成します。
44    // <new_element>というタグ名で、テキストコンテンツを持つノードを作成します。
45    $newChild = $document->createElement('new_element', 'これは新しい要素です！');
46    $newChild->setAttribute('id', 'new'); // 新しいノードに属性を追加
47
48    // 5. oldChild の親ノードを取得します。
49    // replaceChild は親ノードに対して呼び出す必要があります。
50    // ここでは <root> ノードが親になります。
51    $parentNode = $oldChild->parentNode;
52
53    if (!$parentNode) {
54        echo "エラー: 置き換え対象のノードに親ノードがありません。\n";
55        return;
56    }
57
58    // 6. 親ノードの replaceChild メソッドを使って、ノードを置き換えます。
59    // oldChild を newChild で置き換えます。
60    $replacedNode = $parentNode->replaceChild($newChild, $oldChild);
61
62    echo "--- ノード置換後のXMLドキュメント ---\n";
63    echo $document->saveXML();
64    echo "\n";
65
66    // 戻り値は置き換えられた (削除された) 古いノードです。
67    echo "置き換えられた古いノードのタグ名: " . $replacedNode->nodeName . "\n";
68    echo "置き換えられた古いノードのコンテンツ: " . $replacedNode->textContent . "\n";
69}
70
71// 関数の実行
72demonstrateDomReplaceChild();
73

このサンプルコードは、PHP 8で導入された Dom\XMLDocument クラスの replaceChild メソッドを使って、XMLドキュメント内の既存ノードを新しいノードに置き換える方法を示しています。

まず、XMLドキュメントを読み込み、置き換えの対象となる「古い要素」 (<item id="old">) を準備します。次に、その古い要素の代わりになる「新しい要素」 (<new_element id="new">) を作成します。

Dom\Node::replaceChild メソッドは、置き換えたい「古いノード」の「親ノード」に対して呼び出します。このメソッドには二つの引数があります。一つ目の $newChild にはドキュメントに挿入したい新しいノードを指定し、二つ目の $oldChild にはドキュメントから削除したい古いノードを指定します。これにより、$oldChild があった位置に $newChild が挿入され、XMLドキュメントの構造が更新されます。

このメソッドの戻り値は、ドキュメントから置き換えられ、削除された「古いノード」そのものです。この例では、置き換え後に元の古いノードの内容を出力し、メソッドがそのノードを返していることを確認しています。このように replaceChild を利用することで、XMLドキュメントの特定の部分を動的に変更することが可能になります。

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::replaceChild の使用例
5 *
6 * このサンプルコードは、XMLドキュメント内にある特定のノードを
7 * 新しく作成したノードで置き換える方法を示します。
8 */
9function replaceXmlElement(): void
10{
11    // 1. Dom\XMLDocument オブジェクトをインスタンス化
12    $dom = new Dom\XMLDocument();
13
14    // 2. 操作対象となるXML文字列を定義
15    $xmlString = <<<XML
16    <?xml version="1.0" encoding="UTF-8"?>
17    <bookstore>
18      <book category="cooking">
19        <title lang="en">Everyday Italian</title>
20        <author>Giada De Laurentiis</author>
21      </book>
22      <book category="children">
23        <title lang="en">Harry Potter</title>
24        <author>J. K. Rowling</author>
25      </book>
26    </bookstore>
27    XML;
28
29    // XML文字列を読み込んでDOMツリーを構築
30    $dom->loadXML($xmlString);
31
32    // 3. 置換対象の古いノード (oldChild) を取得
33    // ここでは、2番目の <book> 要素を取得します。
34    $oldChild = $dom->getElementsByTagName('book')->item(1);
35
36    // 4. 新しく挿入するノード (newChild) を作成
37    // 新しい <book> 要素を作成します。
38    $newBook = $dom->createElement('book');
39    $newBook->setAttribute('category', 'web');
40
41    $newTitle = $dom->createElement('title', 'Learning PHP');
42    $newTitle->setAttribute('lang', 'en');
43
44    $newAuthor = $dom->createElement('author', 'John Doe');
45
46    // 新しい <book> 要素に子要素として <title> と <author> を追加
47    $newBook->appendChild($newTitle);
48    $newBook->appendChild($newAuthor);
49    
50    // 5. 親ノード上で replaceChild メソッドを実行
51    // 親ノード (<bookstore>) を取得し、$oldChild を $newBook に置き換えます。
52    // メソッドは、削除された古いノード ($oldChild) を返します。
53    if ($oldChild && $oldChild->parentNode) {
54        $removedNode = $oldChild->parentNode->replaceChild($newBook, $oldChild);
55    }
56
57    // 6. 整形して、変更後のXMLを出力
58    $dom->formatOutput = true;
59    echo $dom->saveXML();
60}
61
62// 関数を実行
63replaceXmlElement();

Dom\XMLDocument::replaceChildメソッドは、XMLドキュメント内にある特定の子ノードを、新しく作成した別のノードに置き換える機能を提供します。

このサンプルコードでは、まずloadXMLメソッドで文字列からXMLドキュメントの構造を構築します。次にgetElementsByTagNameメソッドを使い、置き換えの対象となる2番目の<book>要素を取得し、これを引数$oldChildとして準備します。続いて、createElementメソッドなどを用いて、置き換えたい内容を持つ新しい<book>要素をプログラムで作成し、引数$newChildとして準備します。

処理の核心部分では、置き換え対象ノードの親ノード（この場合は<bookstore>）に対してreplaceChildメソッドを実行します。第1引数に新しいノード$newChildを、第2引数に置き換えたい古いノード$oldChildを指定することで、ノードの置き換えが行われます。このとき、メソッドの戻り値として、置き換えによって削除された古いノード（$oldChild）が返されます。

最後にsaveXMLメソッドで結果を出力すると、指定した本の内容が新しい情報に置き換わっていることを確認できます。