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

Copy
1<?php
2
3// このサンプルコードは、PHPのDOMTextクラスに継承された removeChild() メソッドの使用を示します。
4//
5// 重要事項:
6// DOMTextノードは、要素のテキストコンテンツを表すためのものであり、
7// DOMの仕様上、子ノードを持つことができません（常にリーフノードです）。
8// したがって、DOMTextオブジェクトに対して removeChild() を呼び出すと、
9// 指定されたノードがそのDOMTextノードの子ではないため、常にPHP Warningが発生します。
10// 例: PHP Warning: DOMText::removeChild(): Node is not a child of this node
11// この動作は、DOMTextノードの特性に基づく正常な挙動です。
12
13// 新しいDOMドキュメントを作成
14$dom = new DOMDocument('1.0', 'UTF-8');
15$dom->formatOutput = true; // 出力を見やすくする設定
16
17// ドキュメントのルート要素として<example>要素を作成し、追加
18$exampleElement = $dom->createElement('example');
19$dom->appendChild($exampleElement);
20
21// テキストノードを作成
22$textNode = $dom->createTextNode('これはDOMTextノードのテキストコンテンツです。');
23
24// テキストノードを<example>要素の子として追加
25$exampleElement->appendChild($textNode);
26
27// 削除を試みる「子ノード」を作成します。
28// このノードはDOMTextノードの子になることはできません。
29$nodeToAttemptRemoval = $dom->createElement('span', 'このspan要素はDOMTextの子ではありません。');
30
31// DOMTextノード ($textNode) から removeChild() を呼び出して、子ノードの削除を試みます。
32// この操作は、前述の理由によりPHP Warningを発生させます。
33// 戻り値は通常、削除されたノードですが、このケースでは削除が行われないため null となります。
34$removedChild = $textNode->removeChild($nodeToAttemptRemoval);
35
36// $removedChild の値は null になることが期待されます。
37// スクリプトは警告を発生させた後も続行します。
38// 必要に応じて、`error_reporting()` や `try-catch` で警告を処理することも可能ですが、
39// ここではメソッドの直接的な呼び出しを示しています。
40
41// 結果として生成されるDOM構造は、removeChild() の呼び出し前と変わらないはずです。
42// (以下行をコメント解除するとDOM構造が出力されます)
43// echo $dom->saveHTML();
44
45?>

PHP 8のDOMText::removeChildメソッドは、指定された子ノードを親ノードから削除するために使用されます。引数には削除したい子ノード（DOMNode型）を渡し、成功すると削除された子ノードが返されます。

しかし、DOMTextクラスはXMLやHTMLの要素内のテキストコンテンツを表すノードであり、DOMの仕様上、子ノードを持つことができません。つまり、DOMTextノードは常に一番端の「リーフノード」であるという特性があります。

そのため、DOMTextオブジェクトに対してremoveChildメソッドを呼び出し、子ノードの削除を試みると、「Node is not a child of this node」（指定されたノードは子ノードではありません）という内容のPHP Warningが発生します。これはDOMTextノードが子ノードを持てないという特性に基づく正常な動作であり、指定されたノードは実際には削除されません。この場合、戻り値は削除が行われないため、nullとなることが一般的です。

このサンプルコードでは、DOMDocumentを作成し、DOMTextノードを要素の子として追加した後、そのDOMTextノードから別の要素をremoveChildで削除しようと試みています。これにより、前述のPHP Warningが発生する挙動を確認できます。このメソッドは通常、DOMElementのような子ノードを持つことができる要素ノードに対して使用されるものです。