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

Copy
1<?php
2
3/**
4 * DOMNotation::removeChild の動作を確認するサンプル関数
5 *
6 * DOMNotationノードは子ノードを持つことができない仕様です。
7 * そのため、DOMNodeから継承されたremoveChildメソッドを呼び出すと、
8 * 必ずDOMExceptionがスローされます。
9 * このコードは、その動作を実際に確認するものです。
10 */
11function demonstrateDomNotationRemoveChild(): void
12{
13    // DTD(文書型定義)内で記法(NOTATION)を定義したXML文字列を用意します。
14    // DOMNotationオブジェクトはDTDからのみ生成できます。
15    $xmlString = <<<XML
16    <?xml version="1.0" encoding="UTF-8"?>
17    <!DOCTYPE book [
18        <!NOTATION vrml PUBLIC "ISO/IEC 14772:1997" "http://www.web3d.org/specifications/vrml97.sgs">
19        <!ELEMENT book (#PCDATA)>
20    ]>
21    <book>Sample</book>
22    XML;
23
24    // DOMDocumentオブジェクトを作成
25    $doc = new DOMDocument();
26
27    // DTDを解釈するオプションを有効にしてXMLを読み込みます
28    $doc->loadXML($xmlString, LIBXML_DTDLOAD);
29
30    // DocumentTypeノードを取得し、そこに含まれる記法のリスト(DOMNamedNodeMap)を取得します
31    // $doc->doctype は DOMDocumentType オブジェクトです
32    $notations = $doc->doctype->notations;
33
34    // 'vrml' という名前の記法 (DOMNotationオブジェクト) を取得します
35    $vrmlNotation = $notations->getNamedItem('vrml');
36
37    if ($vrmlNotation instanceof DOMNotation) {
38        echo 'DOMNotation オブジェクトを取得しました。' . PHP_EOL;
39        echo 'publicId: ' . $vrmlNotation->publicId . PHP_EOL;
40        echo 'systemId: ' . $vrmlNotation->systemId . PHP_EOL . PHP_EOL;
41    } else {
42        echo 'DOMNotation オブジェクトの取得に失敗しました。' . PHP_EOL;
43        return;
44    }
45
46    // removeChildを試行しますが、DOMNotationは子ノードを持てないため、
47    // DOMExceptionが発生することをtry...catchブロックで確認します。
48    try {
49        // 例外を発生させるために、引数として渡すダミーのDOMNodeオブジェクトを作成
50        $dummyChildNode = new DOMText('this is a dummy node');
51
52        // ここで DOMException がスローされます
53        $vrmlNotation->removeChild($dummyChildNode);
54    } catch (DOMException $e) {
55        // 意図した通り例外が捕捉されたことを示すメッセージを出力します
56        echo "DOMNotation::removeChild() を呼び出しました..." . PHP_EOL;
57        echo "期待通り、DOMExceptionがスローされました。" . PHP_EOL;
58        echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
59    }
60}
61
62// 関数を実行
63demonstrateDomNotationRemoveChild();

PHPのDOMNotation::removeChildは、DOMNodeクラスから継承されたメソッドです。しかし、XMLの仕様上、DOMNotationノードは子ノードを持つことができません。そのため、DOMNotationオブジェクトに対してこのメソッドを呼び出すと、どのような場合でも必ずDOMExceptionというエラー（例外）が発生します。

このメソッドは、引数 $child に削除対象の子ノード（DOMNodeオブジェクト）を受け取ります。正常に完了すれば、削除したノードを戻り値として返しますが、前述の通りDOMNotationでは常に例外が発生するため、実際にノードが削除されたり、戻り値が返されたりすることはありません。

サンプルコードでは、まずDTD（文書型定義）を持つXML文字列からDOMDocumentオブジェクトを生成し、vrmlという名前のDOMNotationオブジェクトを取得しています。その後、try...catchブロック内でremoveChildメソッドを実行し、意図した通りにDOMExceptionがスローされることを実証しています。このコードは、DOMNotationが子ノードを持てないという仕様を確認するためのものです。