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

Copy
1<?php
2
3use Dom\Document;
4use Dom\Element;
5use Dom\Text;
6use Dom\Node; // lastChild の戻り値の型ヒントのために使用
7
8/**
9 * Dom\Text クラスの lastChild プロパティの動作を示すサンプル関数です。
10 *
11 * 「lastChild」という名前は「最後の子」を意味し、配列の「最後のキー (lastkey)」を連想させるかもしれません。
12 * しかし、これらは異なる文脈で使われます。
13 *
14 * Dom\Text ノードはHTMLやXML内のテキストデータを表し、通常は子ノードを持ちません。
15 * そのため、Dom\Text インスタンスの lastChild プロパティは常に null を返します。
16 * このコードは、Dom\Text::lastChild が実際に null を返すことを示します。
17 */
18function demonstrateDomTextLastChildProperty(): void
19{
20    // HTMLドキュメントを作成し、パースします。
21    // Dom\Document::loadHtml() は、基本的なHTML構造 (html, body タグ) を自動的に追加します。
22    $document = new Document();
23    $document->loadHtml('<div>Hello <span>World</span>!</div>');
24
25    // ドキュメント内の最初の 'div' 要素を取得します。
26    // Dom\Element クラスのインスタンスが返されます。
27    /** @var Element|null $divElement */
28    $divElement = $document->getElementsByTagName('div')->item(0);
29
30    if ($divElement instanceof Element) {
31        // div要素の最初の子ノードを取得します。
32        // このHTMLの場合、これはテキストノード "Hello " を表す Dom\Text インスタンスになります。
33        /** @var Node|null $textNode */
34        $textNode = $divElement->firstChild;
35
36        echo "元のHTML断片: " . $divElement->outerHTML . "\n";
37        echo "取得した最初の子ノードのタイプ: " . ($textNode instanceof Text ? "Dom\\Text (テキストノード)" : "その他") . "\n";
38        echo "取得したテキストノードの値: '" . ($textNode instanceof Text ? $textNode->nodeValue : 'N/A') . "'\n";
39
40        // Dom\Text ノードの lastChild プロパティにアクセスします。
41        // Dom\Text ノードは子ノードを持たないため、lastChild は常に null を返します。
42        $lastChildOfText = null;
43        if ($textNode instanceof Text) {
44            $lastChildOfText = $textNode->lastChild;
45        }
46
47        echo "Dom\\Text ノードの lastChild の値: " . ($lastChildOfText === null ? "null" : "別のノードが返されました") . "\n";
48
49        if ($lastChildOfText === null) {
50            echo "この結果は、Dom\\Text ノードが子ノードを持たないというDOMの特性を示しています。\n";
51        }
52
53        // 参考: 子ノードを持つ Dom\Element の lastChild を見てみましょう。
54        echo "\n--- 参考: 子ノードを持つ Dom\\Element の場合 ---\n";
55        // 'div' 要素の子ノードは、Text("Hello "), Element(span), Text("!") です。
56        // そのため、divElement の lastChild はテキストノード "!" になります。
57        /** @var Node|null $divLastChild */
58        $divLastChild = $divElement->lastChild;
59        echo "div要素の最後の子ノード名: " . ($divLastChild instanceof Node ? $divLastChild->nodeName : 'N/A') . "\n";
60        echo "div要素の最後の子ノードの値: " . ($divLastChild instanceof Node ? "'" . $divLastChild->nodeValue . "'" : 'N/A') . "\n";
61        echo "div要素の最後の子ノードのタイプ: " . ($divLastChild instanceof Text ? "Dom\\Text" : ($divLastChild instanceof Element ? "Dom\\Element" : "その他")) . "\n";
62    } else {
63        echo "指定された 'div' 要素が見つかりませんでした。HTMLのパース結果を確認してください。\n";
64    }
65}
66
67// サンプル関数を実行します。
68demonstrateDomTextLastChildProperty();

PHPのDom\Text::lastChildプロパティは、HTMLやXMLドキュメント内でテキストデータを表すDom\Textノードに属し、そのノードが持つ最後の子ノードを取得する際に使用されます。このプロパティは引数を取らず、子ノードが存在すればDom\Nodeオブジェクトを、子ノードが一つもなければnullを戻り値として返します。

しかし、Dom\TextノードはHTMLやXMLの構造上、それ自体がさらに子ノードを持つことはありません。このため、Dom\Textインスタンスに対してlastChildプロパティにアクセスすると、常にnullが返されます。この挙動は、子ノードを持たないすべてのDOMノードに共通するものです。

サンプルコードでは、まずHTMLドキュメントからDom\Textノード（例: "Hello "）を取得し、そのlastChildプロパティにアクセスしています。結果としてnullが返されることを示しており、Dom\Textノードが子を持たないというDOMの基本的な特性を具体的に確認できます。この「lastChild」はDOMツリーにおける子ノードの概念であり、配列の「最後のキー」とは異なる文脈で使われる点にご留意ください。

Copy
1<?php
2
3/**
4 * Dom\TextクラスのlastChildプロパティの動作をデモンストレーションします。
5 * Dom\Textノードは自身の子ノードを持たないため、lastChildプロパティは常にnullを返します。
6 */
7function demonstrateDomTextLastChild(): void
8{
9    // Dom\Documentのインスタンスを作成します。
10    // これはHTMLやXMLドキュメント全体を表現するオブジェクトです。
11    $document = new Dom\Document();
12
13    // HTML要素（例: <p>タグ）を作成し、ドキュメントに追加します。
14    // Dom\Textノードは通常、このような要素の子として存在します。
15    $paragraphElement = $document->createElement('p');
16    $document->appendChild($paragraphElement);
17
18    // テキストノードを作成します。
19    // Dom\Textクラスは、要素内の純粋なテキストコンテンツを表します。
20    $textNode = $document->createTextNode('これはサンプルテキストです。');
21
22    // 作成したテキストノードを<p>要素の子として追加します。
23    // これにより、$textNodeはDOMツリーの一部になります。
24    $paragraphElement->appendChild($textNode);
25
26    // Dom\TextインスタンスのlastChildプロパティにアクセスします。
27    // Dom\Textノードは、その性質上、子ノードを持つことができません。
28    // そのため、lastChildプロパティは常にnullを返します。
29    $lastChildOfTextNode = $textNode->lastChild;
30
31    echo "Dom\\Textノード ('" . $textNode->nodeValue . "') の lastChild プロパティの値:\n";
32    // 期待される出力: null
33    // Dom\Textノードには子ノードが存在しないためです。
34    var_dump($lastChildOfTextNode);
35}
36
37// 関数を実行して、Dom\Text::lastChild の動作を確認します。
38demonstrateDomTextLastChild();
39

PHP 8のDOM拡張機能は、HTMLやXMLドキュメントをプログラムで操作する際に利用されます。このサンプルコードは、その中核をなすDom\TextクラスのlastChildプロパティの動作を示しています。

Dom\Textクラスは、HTMLやXMLドキュメント内の純粋なテキストコンテンツを表すノードです。通常、lastChildプロパティは親ノードの最後の子ノードを取得するために使われます。しかし、Dom\Textノードはテキストそのものであるため、構造上、自身が子ノードを持つことはできません。

コードではまず、Dom\Documentでドキュメントの基盤を作り、次に<p>要素を作成して追加します。その後、「これはサンプルテキストです。」という内容のDom\Textノードを作成し、このテキストノードを<p>要素の子として追加しています。重要なのは、この作成された$textNode（Dom\Textインスタンス）に対してlastChildプロパティにアクセスしている点です。Dom\Textノードには子ノードが存在しないため、$textNode->lastChildは常にnullを返します。

このプロパティに引数はなく、戻り値はDom\Node型かnullのいずれかです。Dom\Textノードのように子を持たない場合はnullが返され、子ノードが存在しないことを示します。この挙動を理解することは、DOM操作の正確性を高める上で重要です。