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

Copy
1<?php
2
3/**
4 * Dom\XMLDocument クラスの lastChild プロパティの使用例を示します。
5 * lastChild は、ドキュメントの最後の子ノードを返します。
6 * XML ドキュメントの場合、通常はルート要素がこれに該当します。
7 */
8function demonstrateDomLastChild(): void
9{
10    // Dom\XMLDocument の新しいインスタンスを作成します。
11    $document = new Dom\XMLDocument();
12
13    // サンプルXML文字列を定義します。
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<root>
17    <element1 id="first">First item</element1>
18    <element2 id="second">Second item</element2>
19</root>
20XML;
21
22    // XML文字列をドキュメントにロードします。
23    if ($document->loadXML($xmlString)) {
24        echo "XMLドキュメントのロードに成功しました。\n";
25
26        // lastChild プロパティを使用して、ドキュメントの最後の子ノードを取得します。
27        // これは通常、XMLのルート要素になります。
28        $lastNode = $document->lastChild;
29
30        // lastNode が Dom\Node オブジェクトであることを確認します。
31        if ($lastNode instanceof Dom\Node) {
32            echo "最後の子ノードが見つかりました。\n";
33            echo "ノード名: " . $lastNode->nodeName . "\n";
34
35            // ノードが要素の場合、タグ名も取得できます。
36            if ($lastNode->nodeType === XML_ELEMENT_NODE) {
37                echo "タグ名: " . $lastNode->tagName . "\n";
38            }
39        } else {
40            echo "最後の子ノードが見つかりませんでした。\n";
41        }
42    } else {
43        echo "XMLドキュメントのロードに失敗しました。\n";
44    }
45}
46
47// 関数を実行します。
48demonstrateDomLastChild();

このPHPコードは、PHP 8で提供されるDOM拡張機能の一部であるDom\XMLDocumentクラスのlastChildプロパティの使い方を説明しています。Dom\XMLDocumentは、XMLドキュメントをプログラムから作成、読み込み、操作するためのクラスです。

まず、Dom\XMLDocumentの新しいインスタンスを作成し、loadXMLメソッドを使って定義されたXML文字列を読み込んでいます。これにより、指定されたXMLの構造がメモリ上にオブジェクトとして表現されます。

次に、$document->lastChildという形でlastChildプロパティにアクセスしています。このプロパティは、対象となるドキュメントの「最後の子ノード」を取得するために使用されます。lastChildは引数を取らず、戻り値としてDom\Nodeオブジェクトを返しますが、もし子ノードが存在しない場合はnullを返します。XMLドキュメントの場合、通常、この「最後の子ノード」はドキュメントのルート要素に該当します。

サンプルコードでは、取得したノードが実際にDom\Node型であることを確認した上で、そのノードのnodeName（ノード名）と、もし要素であればtagName（タグ名）を出力しています。この例から、lastChildプロパティを使うことで、XMLドキュメントの構造内で特定の主要な要素に効率的にアクセスできることがわかります。

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::lastChild プロパティの使用例を示します。
5 *
6 * このコードは、PHP 8で導入された新しいDOM拡張である `Dom` 名前空間を使用し、
7 * XML ドキュメントのDOMツリーにおける「最後の子ノード」を取得する方法を解説します。
8 *
9 * `Dom\XMLDocument` の `lastChild` プロパティは、通常、ドキュメントのルート要素を指します。
10 * これは、配列で最後の要素を取得する `last()` の概念と類似しており、
11 * DOMツリーの文脈で最後の要素にアクセスする方法です。
12 */
13function demonstrateXmlDocumentLastChild(): void
14{
15    // サンプルとなるXML文字列を定義します。
16    // このXMLでは、<bookstore> がドキュメントのルート要素です。
17    $xmlString = <<<XML
18<?xml version="1.0" encoding="UTF-8"?>
19<bookstore>
20    <book category="cooking">
21        <title lang="en">Everyday Italian</title>
22        <author>Giada De Laurentiis</author>
23        <year>2005</year>
24        <price>30.00</price>
25    </book>
26    <book category="web">
27        <title lang="en">Learning XML</title>
28        <author>Erik T. Ray</author>
29        <year>2003</year>
30        <price>39.95</price>
31    </book>
32</bookstore>
33XML;
34
35    // Dom\XMLDocument オブジェクトを新しく作成します。
36    // これはXMLドキュメント全体を表すオブジェクトです。
37    $document = new Dom\XMLDocument();
38
39    // XML文字列をロードして、Dom\XMLDocument オブジェクトにパースさせます。
40    // loadXML() が失敗した場合の一般的なエラーハンドリングは、簡潔さのため省略しています。
41    $document->loadXML($xmlString);
42
43    // Dom\XMLDocument の lastChild プロパティにアクセスします。
44    // このプロパティは、ドキュメントの直接の子ノードの中で最後に位置するノードを返します。
45    // XMLドキュメントの場合、通常はルート要素（この例では <bookstore>）が該当します。
46    // 戻り値は ?Dom\Node 型で、子ノードがない場合（または無効なドキュメントの場合）は null を返します。
47    $lastNode = $document->lastChild;
48
49    // lastChild が null でないことを確認し、取得したノードの情報を表示します。
50    if ($lastNode !== null) {
51        echo "ドキュメントの最後の子ノードが見つかりました。\n";
52        echo "------------------------------------------\n";
53        echo "ノード名 (nodeName): " . $lastNode->nodeName . "\n";
54        // nodeType はノードの種類を示す整数値です。
55        // 1 は要素ノード (Element Node) を意味します。
56        echo "ノードタイプ (nodeType): " . $lastNode->nodeType . " (1 = 要素ノード)\n";
57        // 要素ノードの nodeValue は、通常、子テキストノードを持たない限り空文字列になります。
58        echo "ノードの値 (nodeValue): '" . $lastNode->nodeValue . "'\n";
59        echo "------------------------------------------\n";
60        echo "取得したノードのXML表現:\n";
61        // saveXML() を使用して、ノードとその子孫をXML形式で出力します。
62        echo $document->saveXML($lastNode);
63    } else {
64        echo "ドキュメントに子ノードがありませんでした。\n";
65    }
66}
67
68// 上記で定義した関数を実行します。
69demonstrateXmlDocumentLastChild();
70

Dom\XMLDocument::lastChildプロパティは、PHP 8で導入された新しいDOM拡張であるDom名前空間に属し、XMLドキュメントのDOMツリーにおける「最後の子ノード」を取得するために使用されます。このプロパティは引数を持ちません。Dom\XMLDocumentオブジェクトに対して使用する場合、通常はドキュメントのルート要素が最後の子ノードとして取得されます。例えば、<?xml version="1.0"?><root>...</root>というXMLにおいて、<root>要素が該当します。

戻り値は?Dom\Node型で、ドキュメントに子ノードが存在しない場合や無効な場合はnullが返されます。これは配列の末尾の要素にアクセスする操作に似ており、DOMツリーの文脈で特定のノードを特定する際に役立ちます。

サンプルコードでは、まずXML文字列を定義し、それをDom\XMLDocumentオブジェクトにロードして解析しています。その後、$document->lastChildプロパティにアクセスすることで、ドキュメントの最後の子ノードを取得しています。取得したノードがnullでないことを確認した上で、そのノード名やタイプ、XML形式での表現を表示し、実際にどのノードが最後の子であるかを確認できる内容になっています。これにより、XMLドキュメントのルート要素へ容易にアクセスし、その内容を処理することが可能になります。