【PHP8.x】firstChildプロパティの使い方

Copy
1<?php
2
3// DOMDocumentのインスタンスを作成します。
4// XMLバージョンとエンコーディングを指定します。
5$dom = new DOMDocument('1.0', 'UTF-8');
6
7// DTD (文書型定義) を含むXML文字列をロードします。
8// DOMDocumentType::firstChild は、DTDノード自体は子ノードを持たないため、常に null を返します。
9// このサンプルコードは、この事実を確認し、初心者にも理解できるよう説明します。
10$xmlString = <<<XML
11<!DOCTYPE root SYSTEM "example.dtd">
12<root>
13    <element/>
14</root>
15XML;
16
17// XML文字列をDOMDocumentに読み込みます。
18// loadXML() メソッドは、XMLコンテンツとそのDTD宣言を解析します。
19$dom->loadXML($xmlString);
20
21// DOMDocumentオブジェクトからDOMDocumentTypeノードを取得します。
22// このノードは、XMLドキュメントのDOCTYPE宣言全体を表します。
23$doctype = $dom->doctype;
24
25// DOMDocumentTypeノードが正常に取得できたかを確認します。
26if ($doctype instanceof DOMDocumentType) {
27    echo "DOMDocumentType情報:\n";
28    echo "  名前: " . $doctype->name . "\n"; // ドキュメントのルート要素名 (例: "root")
29    echo "  システムID: " . ($doctype->systemId ?: "なし") . "\n"; // 外部DTDファイルのURI (例: "example.dtd")
30    echo "  パブリックID: " . ($doctype->publicId ?: "なし") . "\n"; // 外部DTDのパブリック識別子
31
32    // DOMDocumentTypeの firstChild プロパティにアクセスします。
33    // DTDノード自体は論理的な構造体であり、他のDOMノードのように子要素を持つことはありません。
34    // そのため、このプロパティは常に null を返します。
35    $firstChild = $doctype->firstChild;
36
37    echo "\nDOMDocumentTypeの最初の子供ノードの確認:\n";
38    if ($firstChild === null) {
39        echo "  結果: null が返されました。\n";
40        echo "  説明: DOMDocumentTypeノードは子ノードを持たないため、"
41            . "firstChild プロパティは常に null を返します。\n";
42    } else {
43        // このelseブロックは通常、DOMDocumentType::firstChild の仕様により実行されません。
44        echo "  ノード名: " . $firstChild->nodeName . "\n";
45        echo "  ノードタイプ: " . $firstChild->nodeType . "\n";
46        echo "  ノード値: " . $firstChild->nodeValue . "\n";
47    }
48} else {
49    echo "DOMDocumentTypeノードが見つかりませんでした。\n";
50    echo "これは、指定されたXMLにDOCTYPE宣言が含まれていない場合に発生します。\n";
51}
52
53?>

このPHPサンプルコードは、XMLドキュメントのDOCTYPE宣言を扱うDOMDocumentTypeクラスのfirstChildプロパティの挙動を、システムエンジニアを目指す初心者向けに解説しています。 まず、DOMDocumentインスタンスを作成し、<!DOCTYPE>宣言を含むXML文字列を読み込みます。次に、$dom->doctypeプロパティを使用してDOMDocumentTypeノードを取得し、そのnameやsystemIdといった関連情報を表示します。

DOMDocumentTypeクラスのfirstChildプロパティは引数を持たず、通常は現在のノードの最初の子ノードをDOMNodeオブジェクトとして返そうとします。しかし、DOMDocumentTypeノードはXMLの文書型定義全体を表す論理的な構造であり、他の要素ノードのように具体的な子ノードを持つことはありません。このため、DOMDocumentType::firstChildにアクセスした場合、その戻り値は常にnullとなります。サンプルコードでは、このプロパティが実際にnullを返すことを確認し、DOMDocumentTypeノードが子ノードを持たないというDOMの仕様を具体的に示しています。