【PHP8.x】DOMEntity::lastChildプロパティの使い方

Copy
1<?php
2
3/**
4 * DOMEntity::lastChild プロパティの使用例を示す関数。
5 *
6 * この関数は、XMLのDTD（Document Type Definition）で定義されたエンティティから、
7 * そのエンティティが持つ最後の子ノードを取得し、その情報を表示します。
8 * DOM (Document Object Model) の概念と、XMLエンティティの構造を
9 * システムエンジニアを目指す初心者にも分かりやすく解説します。
10 *
11 * キーワード「lastkey」が「最後」を意味するように、
12 * このプロパティはDOMツリーにおける「最後の子ノード」を取得する際に使用されます。
13 */
14function demonstrateDomEntityLastChild(): void
15{
16    // 新しいDOMDocumentインスタンスを作成します。
17    // XMLのバージョンとエンコーディングを指定します。
18    $dom = new DOMDocument('1.0', 'UTF-8');
19    // 空白文字のみのテキストノードを無視し、出力を整形することで読みやすくします。
20    $dom->preserveWhiteSpace = false;
21    $dom->formatOutput = true;
22
23    // XML文字列を定義します。
24    // ここで重要なのは、<!DOCTYPE doc [...]> の部分でDTD（Document Type Definition）を宣言し、
25    // その内部サブセットで <!ENTITY example "Hello <b>World</b>!"> というエンティティを定義している点です。
26    // このエンティティの内容は「Hello 」(テキストノード)、「<b>」(要素ノード)、「!」(テキストノード)
27    // の3つの子ノードで構成されます。
28    $xmlString = <<<XML
29<?xml version="1.0" encoding="UTF-8"?>
30<!DOCTYPE doc [
31    <!ENTITY example "Hello <b>World</b>!">
32]>
33<doc>&example;</doc>
34XML;
35
36    // 定義したXML文字列をDOMDocumentにロードします。
37    if (!$dom->loadXML($xmlString)) {
38        echo "XMLのロードに失敗しました。\n";
39        return;
40    }
41
42    // ドキュメントのDOCTYPE (DOMDocumentType) オブジェクトを取得します。
43    // DTDの情報はこのオブジェクトに含まれます。
44    $doctype = $dom->doctype;
45
46    if (!$doctype) {
47        echo "DOCTYPEが見つかりませんでした。XMLにDTDが定義されているか確認してください。\n";
48        return;
49    }
50
51    // DOMDocumentTypeから、定義されているすべてのエンティティのリスト (NamedNodeMap) を取得します。
52    $entities = $doctype->entities;
53
54    // リストから名前が 'example' のDOMEntityオブジェクトを取得します。
55    // 'getNamedItem' メソッドは、指定された名前のノードを返します。
56    $entity = $entities->getNamedItem('example');
57
58    if ($entity instanceof DOMEntity) {
59        echo "エンティティ 'example' が正常に見つかりました。\n";
60
61        // DOMEntity::lastChild プロパティを使用して、
62        // エンティティが展開された際の最後の子ノードを取得します。
63        // 上記のエンティティ定義 "Hello <b>World</b>!" の場合、
64        // 子ノードは「"Hello " (テキスト)」、「<b> (要素)」、「"!" (テキスト)」の順になるため、
65        // 最後の子ノードはテキストノード「!」となります。
66        $lastChildNode = $entity->lastChild;
67
68        if ($lastChildNode) {
69            echo "--- DOMEntity::lastChild の結果 ---\n";
70            echo "  ノード名: " . $lastChildNode->nodeName . "\n";
71            echo "  ノードタイプ: " . $lastChildNode->nodeType . " (定数: " . getDomNodeTypeConstantName($lastChildNode->nodeType) . ")\n";
72            echo "  ノード値: '" . $lastChildNode->nodeValue . "'\n";
73            echo "----------------------------------\n";
74        } else {
75            echo "DOMEntity 'example' には子ノードがありませんでした。\n";
76        }
77    } else {
78        echo "エンティティ 'example' が見つからないか、DOMEntity型ではありませんでした。\n";
79    }
80}
81
82/**
83 * DOMノードタイプ定数の整数値を、人間が読める文字列に変換するヘルパー関数。
84 *
85 * 初心者がDOMノードタイプを理解するのを助けるために使用されます。
86 * PHP 8 で導入された `match` 式を使用しています。
87 *
88 * @param int $nodeType DOMノードタイプを表す整数値 (例: XML_TEXT_NODE)
89 * @return string ノードタイプの人間が読める名前
90 */
91function getDomNodeTypeConstantName(int $nodeType): string
92{
93    return match ($nodeType) {
94        XML_ELEMENT_NODE        => 'XML_ELEMENT_NODE',         // 1: 要素ノード
95        XML_ATTRIBUTE_NODE      => 'XML_ATTRIBUTE_NODE',       // 2: 属性ノード
96        XML_TEXT_NODE           => 'XML_TEXT_NODE',            // 3: テキストノード
97        XML_CDATA_SECTION_NODE  => 'XML_CDATA_SECTION_NODE',   // 4: CDATAセクションノード
98        XML_ENTITY_REF_NODE     => 'XML_ENTITY_REF_NODE',      // 5: エンティティ参照ノード
99        XML_ENTITY_NODE         => 'XML_ENTITY_NODE',          // 6: エンティティノード
100        XML_PI_NODE             => 'XML_PROCESSING_INSTRUCTION_NODE', // 7: 処理命令ノード
101        XML_COMMENT_NODE        => 'XML_COMMENT_NODE',         // 8: コメントノード
102        XML_DOCUMENT_NODE       => 'XML_DOCUMENT_NODE',        // 9: ドキュメントノード
103        XML_DOCUMENT_TYPE_NODE  => 'XML_DOCUMENT_TYPE_NODE',   // 10: ドキュメントタイプノード
104        XML_DOCUMENT_FRAG_NODE  => 'XML_DOCUMENT_FRAG_NODE',   // 11: ドキュメントフラグメントノード
105        XML_NOTATION_NODE       => 'XML_NOTATION_NODE',        // 12: 記法ノード
106        default                 => 'UNKNOWN_NODE_TYPE',        // 不明なノードタイプ
107    };
108}
109
110// 関数を実行してデモンストレーションを開始します。
111demonstrateDomEntityLastChild();
112

DOMEntity::lastChildは、PHPのDOM拡張機能において、XMLのDTD（Document Type Definition）で定義されたエンティティが持つ「最後の子ノード」を取得するためのプロパティです。DOMEntityクラスは、XMLドキュメントのDTD内で定義される<!ENTITY ...>のようなエンティティを表します。

このlastChildプロパティにアクセスすると、引数なしで、そのエンティティが展開された際の内容のうち、最も最後に位置する子ノードを取得できます。戻り値はDOMNode型で、取得された子ノード（要素やテキストなど）を表します。もしエンティティに子ノードが存在しない場合はnullが返されます。

サンプルコードでは、<!ENTITY example "Hello <b>World</b>!">というエンティティを定義し、そのDOMEntityオブジェクトからlastChildプロパティを用いて最後の子ノードを取得しています。このエンティティの内容は「Hello 」（テキストノード）、「<b>」（要素ノード）、「!」（テキストノード）の順で構成されるため、テキストノードである「!」が最後の子ノードとして取得されることを示しています。このように、キーワードlastkeyが示すように、DOMツリー構造における特定のエンティティ内の最後の要素への効率的なアクセスが可能です。

Copy
1<?php
2
3/**
4 * DOMEntityオブジェクトから最後の子ノードを取得し、情報を表示するサンプル。
5 *
6 * システムエンジニアを目指す初心者が、XMLのDTDで定義されたエンティティの
7 * lastChildプロパティ（最後の子ノード）の利用方法を理解するのに役立ちます。
8 */
9function demonstrateDomEntityLastChild(): void
10{
11    // DTD (Document Type Definition) を含むXML文字列を定義します。
12    // ここでは 'myentity' と 'anotherentity' という2つのエンティティを定義しています。
13    // 'myentity' は複数のHTML要素を含む構造を持ち、
14    // 'anotherentity' は単純なテキストのみを持ちます。
15    $xmlString = <<<XML
16<!DOCTYPE root [
17  <!ENTITY myentity "<b>Bold Part</b> and <i>Italic Part</i>.">
18  <!ENTITY anotherentity "Just some plain text.">
19]>
20<root>
21  <!-- このXML内部でのエンティティ参照は、DOMEntityのlastChildプロパティの
22       動作には直接影響しませんが、DTDがロードされていることを示します。 -->
23  &myentity;
24  &anotherentity;
25</root>
26XML;
27
28    // 新しいDOMDocumentインスタンスを作成します。
29    $dom = new DOMDocument();
30
31    // XML文字列をDOMDocumentにロードします。
32    // LIBXML_DTDLOAD: DTDをロードし、内部サブセットを処理することを許可します。
33    // LIBXML_DTDATTR: DTDによって定義されたデフォルト属性を適用します。
34    // これらのオプションは、XML内で定義されたエンティティにアクセスするために重要です。
35    $dom->loadXML($xmlString, LIBXML_DTDLOAD | LIBXML_DTDATTR);
36
37    // ドキュメントのDOCTYPE (DTD) ノードを取得します。
38    // DOMEntityオブジェクトにアクセスするには、このDOCTYPEノードを経由する必要があります。
39    $doctype = $dom->doctype;
40
41    if ($doctype instanceof DOMDocumentType) {
42        echo "DTD (Document Type Definition) が見つかりました。\n";
43        echo "----------------------------------------\n";
44
45        // DOMDocumentTypeオブジェクトから定義されたエンティティのマップを取得します。
46        // これはDOMNamedNodeMapオブジェクトであり、キー（エンティティ名）でアクセスできます。
47        $entities = $doctype->entities;
48
49        // エンティティが存在するかどうかを確認します。
50        if ($entities->length > 0) {
51            echo "定義されたエンティティの数: " . $entities->length . "\n\n";
52
53            // 各エンティティをループ処理します。
54            foreach ($entities as $entity) {
55                // $entity が DOMEntity インスタンスであることを確認します。
56                if ($entity instanceof DOMEntity) {
57                    echo "エンティティ名: '{$entity->nodeName}'\n";
58                    echo "エンティティ値 (展開された内容の文字列): '{$entity->nodeValue}'\n";
59
60                    // DOMEntityのlastChildプロパティを取得します。
61                    // これはエンティティの内容をDOMツリーとして解釈した際の、最後の子ノードです。
62                    $lastChild = $entity->lastChild;
63
64                    if ($lastChild !== null) {
65                        echo "  lastChildノード名: '{$lastChild->nodeName}'\n";
66                        echo "  lastChildノード値: '{$lastChild->nodeValue}'\n";
67                        echo "  lastChildノードタイプ: " . $lastChild->nodeType . " (DOM_ELEMENT_NODE=1, DOM_TEXT_NODE=3)\n";
68                    } else {
69                        // エンティティが空であるか、または内容が特殊でlastChildが存在しない稀なケース
70                        echo "  lastChildはnullです。\n";
71                    }
72                    echo "\n";
73                }
74            }
75        } else {
76            echo "DTD内に定義されたエンティティは見つかりませんでした。\n";
77        }
78    } else {
79        echo "XMLドキュメントにDTDが見つかりませんでした。DTDを含まないXMLかもしれません。\n";
80    }
81}
82
83// 上記で定義した関数を実行して、サンプルコードの動作を確認します。
84demonstrateDomEntityLastChild();
85

PHPのDOMEntity::lastChildプロパティは、XMLのDTD（Document Type Definition）で定義されたエンティティが持つ、最後の子ノードを取得するためのプロパティです。このプロパティに引数はなく、エンティティの内容がDOMツリーとして解釈された際の最後の子ノードをDOMNodeオブジェクトとして返します。もし子ノードが存在しない場合や、内容が特殊で最後の子ノードと認識されない稀なケースではnullを返します。

このサンプルコードでは、DTD内に「myentity」と「anotherentity」という2つのエンティティを定義したXML文字列を準備し、DOMDocumentにロードしています。loadXMLメソッドにLIBXML_DTDLOADとLIBXML_DTDATTRオプションを指定することで、DTDの解析とエンティティへのアクセスを可能にしています。

ロード後、DOMDocumentTypeオブジェクトからエンティティのコレクションを取得し、それぞれのDOMEntityインスタンスに対してlastChildプロパティを使用します。「myentity」のように複数のHTML要素を含むエンティティの場合、lastChildは最後の要素（この例では<i>タグ）を返します。「anotherentity」のように単純なテキストのみを含むエンティティの場合、lastChildはテキストノードを返します。これにより、エンティティの内容が展開された後の構造における末尾の要素やテキストノードを正確に確認することができます。