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

Copy
1<?php
2
3// 再帰的にDOMノードを走査し、Dom\EntityReference ノードを見つけるためのヘルパー関数
4function findEntityReferences(Dom\Node $node, array &$foundEntities): void
5{
6    // 現在のノードが Dom\EntityReference のインスタンスであれば、配列に追加
7    if ($node instanceof Dom\EntityReference) {
8        $foundEntities[] = $node;
9    }
10
11    // 子ノードがある場合、それぞれの子ノードに対して再帰的にこの関数を呼び出す
12    if ($node->hasChildNodes()) {
13        foreach ($node->childNodes as $childNode) {
14            findEntityReferences($childNode, $foundEntities);
15        }
16    }
17}
18
19/**
20 * Dom\EntityReference クラスの lastChild プロパティの使用例を示します。
21 *
22 * この関数は、DTD（Document Type Definition）で定義されたエンティティが
23 * XMLドキュメント内で参照される際の挙動と、lastChildプロパティが返す値をデモンストレーションします。
24 * Dom\EntityReference は、XMLやHTMLのパース時にエンティティ参照を表すノードとして扱われます。
25 */
26function demonstrateEntityReferenceLastChild(): void
27{
28    // DTDでエンティティを定義し、それを参照するXML文字列
29    // 'mycomplex' エンティティは複数の子ノードを持つコンテンツを含むため、
30    // lastChild の挙動を明確に示す良い例となります。
31    $xmlString = <<<XML
32<!DOCTYPE example [
33  <!ENTITY simple "Simple Text">
34  <!ENTITY mycomplex "これは<b>複雑な</b>テキスト<i>です</i>。">
35  <!ENTITY empty_entity "">
36]>
37<root>
38  <item id="1">エンティティ参照: &simple;</item>
39  <item id="2">エンティティ参照: &mycomplex;</item>
40  <item id="3">空のエンティティ参照: &empty_entity;</item>
41  <item id="4">未定義のエンティティ参照: &unknown_entity;</item>
42</root>
43XML;
44
45    $dom = new Dom\Document();
46    // エンティティ参照をノードとして保持し、展開しないように設定します。
47    // これにより、XMLパース時に Dom\EntityReference オブジェクトが生成されます。
48    $dom->substituteEntities = false;
49    // XMLを読み込みます。
50    // LIBXML_NOENT: 未定義のエンティティ参照があってもエラーを発生させません。
51    // LIBXML_DTDLOAD: ドキュメントのDTDをロードし、エンティティ定義を認識させます。
52    $dom->loadXML($xmlString, LIBXML_NOENT | LIBXML_DTDLOAD);
53
54    echo "Dom\\EntityReference::lastChild プロパティのデモンストレーション:\n\n";
55
56    // ドキュメント全体から Dom\EntityReference ノードをすべて見つけます。
57    $foundEntityReferences = [];
58    findEntityReferences($dom, $foundEntityReferences);
59
60    if (empty($foundEntityReferences)) {
61        echo "Dom\\EntityReference ノードは見つかりませんでした。\n";
62        echo "XML文字列と Dom\\Document の設定 (substituteEntities = false) を確認してください。\n";
63        return;
64    }
65
66    // 見つかった各 Dom\EntityReference ノードに対して処理を行います
67    foreach ($foundEntityReferences as $entityReferenceNode) {
68        echo "--- Dom\\EntityReference ノードを見つけました ---\n";
69        // Dom\EntityReference の nodeName は、参照しているエンティティの名前になります。
70        echo "  ノード名 (エンティティ名): " . $entityReferenceNode->nodeName . "\n";
71
72        // lastChild プロパティにアクセスします。
73        // これは、エンティティが展開された場合の最後の子ノードを返します。
74        // エンティティが空であるか、展開後のコンテンツがない場合は null を返します。
75        $lastChild = $entityReferenceNode->lastChild;
76
77        if ($lastChild !== null) {
78            echo "  lastChild が見つかりました。\n";
79            echo "    lastChild のノード名: " . $lastChild->nodeName . "\n";
80            // ノード値が非常に長い場合に表示を短縮して見やすくします
81            $nodeValuePreview = (mb_strlen($lastChild->nodeValue) > 50) ?
82                                  mb_substr($lastChild->nodeValue, 0, 50) . "..." :
83                                  $lastChild->nodeValue;
84            echo "    lastChild のノード値: '" . $nodeValuePreview . "'\n";
85            // ノードタイプを人間が読める形式で表示します
86            echo "    lastChild のノードタイプ: " . Dom\Node::nodeTypeName($lastChild->nodeType) . "\n";
87        } else {
88            echo "  lastChild はありません (null)。エンティティが空であるか、参照先がない可能性があります。\n";
89        }
90        echo "\n";
91    }
92}
93
94// デモンストレーション関数を実行
95demonstrateEntityReferenceLastChild();
96
97?>

PHPのDom\EntityReferenceクラスは、XMLドキュメント内で&entity_name;のように記述されるエンティティ参照を表すノードです。このlastChildプロパティは、エンティティが展開されたコンテンツの最後の子ノードを返します。もしエンティティが空であるか、展開後のコンテンツが子ノードを持たない場合はnullを返します。

サンプルコードでは、DTD（Document Type Definition）で定義された複数のエンティティ参照を含むXMLを処理しています。Dom\DocumentオブジェクトのsubstituteEntitiesプロパティをfalseに設定することで、XMLのパース時にエンティティ参照がDom\EntityReferenceオブジェクトとして保持されるようにしています。

コードはまず、ヘルパー関数を使ってドキュメント全体からすべてのDom\EntityReferenceノードを検索します。その後、見つかった各エンティティ参照に対してlastChildプロパティにアクセスし、その戻り値を確認します。例えば、「&mycomplex;」のように複数の要素（例: <b>や<i>タグ）を含む複雑なエンティティが参照されている場合、lastChildプロパティはその展開結果における最後の要素（この例では<i>タグに対応するノード）を返します。一方、「&empty_entity;」のように空のエンティティ参照の場合や、展開後に子ノードを持たないエンティティの場合は、lastChildはnullを返します。このように、lastChildプロパティは参照されているエンティティの具体的な内容に応じて異なるDom\Nodeオブジェクト、またはnullを返します。

Copy
1<?php
2
3/**
4 * Dom\EntityReference::lastChild プロパティの使用例
5 *
6 * このスクリプトは、PHPのDom拡張機能を用いてXMLをパースし、
7 * XMLエンティティ参照 (例: &myentity;) が表す Dom\EntityReference ノードの
8 * 最後の子ノードを取得する方法を示します。
9 *
10 * システムエンジニアを目指す初心者の方へ：
11 * Dom\EntityReference は、XMLやHTMLで定義された「エンティティ」（例えば「&amp;」やカスタム定義されたもの）
12 * を参照する特別なノードです。lastChild プロパティは、このエンティティ参照が
13 * ドキュメントツリー上で展開された際の内容（子ノード）の最後のノードを取得するために使われます。
14 */
15
16// XML文字列を定義します。内部DTDで 'myentity' というエンティティを定義し、
17// その内容が複数の子ノード（テキストノードと要素ノード）を持つようにします。
18$xmlString = <<<XML
19<!DOCTYPE root [
20  <!ENTITY myentity "Hello World! <span class='highlight'>Important</span>">
21]>
22<root>&myentity;</root>
23XML;
24
25// Dom\Document のインスタンスを作成します。
26$dom = new Dom\Document();
27
28// ドキュメントがエンティティ参照を展開せず、Dom\EntityReference ノードとして扱うように設定します。
29// この設定がない場合、&myentity; はパース時にその内容に置き換えられ、
30// Dom\EntityReference ノードはツリーに存在しなくなります。
31$dom->substituteEntities = false;
32
33// 外部エンティティの解決を行わないように設定します。
34// （今回のXMLでは内部DTDなので直接的な影響は少ないですが、一般的な設定です。）
35$dom->resolveExternalEntities = false;
36
37// XML文字列をDOMオブジェクトに読み込みます。
38if (!$dom->loadXML($xmlString)) {
39    echo "エラー: XMLの読み込みに失敗しました。\n";
40    exit(1);
41}
42
43// ルート要素 (<root>) を取得します。
44$root = $dom->getElementsByTagName('root')->item(0);
45
46if ($root === null) {
47    echo "エラー: ルート要素が見つかりませんでした。\n";
48    exit(1);
49}
50
51// <root>要素の子ノードを走査し、Dom\EntityReference オブジェクトを探します。
52// substituteEntities が false なので、&myentity; は Dom\EntityReference ノードとして存在します。
53$entityReferenceNode = null;
54foreach ($root->childNodes as $childNode) {
55    if ($childNode instanceof Dom\EntityReference) {
56        $entityReferenceNode = $childNode;
57        break;
58    }
59}
60
61if ($entityReferenceNode === null) {
62    echo "エラー: Dom\\EntityReference ノードが見つかりませんでした。\n";
63    echo "XMLの構造または substituteEntities の設定を確認してください。\n";
64    exit(1);
65}
66
67echo "Dom\\EntityReference ノード (名前: " . $entityReferenceNode->nodeName . ") を見つけました。\n";
68
69// Dom\EntityReference::lastChild プロパティにアクセスします。
70// これは、エンティティの内容が展開された際の子ノードリストの最後のノードを返します。
71// 今回のXMLでは、"Hello World! " (テキストノード) と
72// "<span class='highlight'>Important</span>" (要素ノード) が子ノードとなるため、
73// lastChild は <span class='highlight'>Important</span> 要素になります。
74$lastChild = $entityReferenceNode->lastChild;
75
76if ($lastChild !== null) {
77    echo "Dom\\EntityReference の最後の子ノードは " . get_class($lastChild) . " です。\n";
78    echo "  ノード名: " . $lastChild->nodeName . "\n";
79    echo "  ノード値: " . $lastChild->nodeValue . "\n";
80
81    // 最後の子ノードが Dom\Element (要素) であれば、属性も表示できます。
82    if ($lastChild instanceof Dom\Element && $lastChild->hasAttribute('class')) {
83        echo "  'class' 属性値: " . $lastChild->getAttribute('class') . "\n";
84    }
85} else {
86    echo "Dom\\EntityReference ノードには子ノードがありません。\n";
87}
88
89?>

Dom\EntityReference::lastChildプロパティは、PHPのDOM拡張機能において、XMLやHTMLドキュメント内のエンティティ参照（例えば&のような特殊文字やユーザー定義エンティティ）を表すDom\EntityReferenceノードの最後の子ノードを取得するために使用されます。エンティティ参照は、ドキュメントツリー上で特定のコンテンツを再利用する仕組みであり、このプロパティは、その参照が展開された際の内容の末尾に位置するノードを特定する際に役立ちます。

このプロパティは引数を一切取らず、戻り値として最後の子ノードをDom\Nodeオブジェクトで返します。もし対象のエンティティ参照に子ノードが存在しない場合はnullを返します。

サンプルコードでは、&myentity;というXMLエンティティ参照を定義し、Dom\DocumentクラスのsubstituteEntitiesプロパティをfalseに設定することで、このエンティティがパース時に展開されずにDom\EntityReferenceノードとして扱われるようにしています。これにより、プログラムで直接エンティティ参照ノードにアクセスし、そのlastChildプロパティを利用できます。具体的には、「Hello World! <span class='highlight'>Important</span>」というmyentityの内容から、最後の子ノードである<span class='highlight'>Important</span>要素を取得し、そのノード名やクラス属性の値を表示しています。これは、エンティティ参照の中身を詳細に検査したい場合に有効な手法です。