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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\EntityReferenceのfirstChildプロパティの使用例を示します。
7 *
8 * XMLドキュメント内のエンティティ参照(&author;)を取得し、
9 * その最初の子ノード(この場合はテキストノード)の内容を出力します。
10 */
11function displayEntityReferenceFirstChild(): void
12{
13    // DTD(文書型定義)で内部エンティティ 'author' を定義したXML文字列
14    $xmlString = <<<XML
15    <?xml version="1.0" encoding="UTF-8"?>
16    <!DOCTYPE book [
17        <!ENTITY author "Taro Yamada">
18    ]>
19    <book>
20        <author>&author;</author>
21    </book>
22    XML;
23
24    // DOMDocumentオブジェクトを作成
25    $dom = new \DOMDocument();
26
27    // XML文字列を読み込みます。
28    // PHPのデフォルト設定ではエンティティ参照はノードとして保持されます。
29    // ($dom->substituteEntities を true にすると、エンティティがテキストに置き換えられ
30    //  Dom\EntityReferenceノードが生成されなくなるため注意が必要です)
31    $dom->loadXML($xmlString);
32
33    // XPathを使って <author> 要素を取得
34    $xpath = new \DOMXPath($dom);
35    $authorElement = $xpath->query('//author')->item(0);
36
37    // <author>要素の最初の子ノードであるエンティティ参照ノード (&author;) を取得
38    $entityRefNode = $authorElement->firstChild;
39
40    // 取得したノードが Dom\EntityReference のインスタンスであるかを確認
41    if ($entityRefNode instanceof \Dom\EntityReference) {
42        echo "エンティティ参照ノード (&{$entityRefNode->nodeName};) を取得しました。" . PHP_EOL;
43
44        // firstChildプロパティでエンティティ参照の最初の子ノードを取得します。
45        // エンティティ'author'はテキスト "Taro Yamada" を持つため、
46        // そのテキストを表す Dom\Text ノードが返されます。
47        $firstChildOfEntity = $entityRefNode->firstChild;
48
49        if ($firstChildOfEntity !== null) {
50            // 子ノードの型と内容を出力します。
51            echo "firstChildの型: " . $firstChildOfEntity::class . PHP_EOL;
52            echo "firstChildの内容 (nodeValue): " . $firstChildOfEntity->nodeValue . PHP_EOL;
53        } else {
54            echo "このエンティティ参照に子ノードはありません。" . PHP_EOL;
55        }
56    } else {
57        echo "エンティティ参照ノードが見つかりませんでした。" . PHP_EOL;
58    }
59}
60
61// 関数を実行
62displayEntityReferenceFirstChild();
63

このPHPサンプルコードは、XMLドキュメント内に定義されたエンティティ参照（Dom\EntityReference）が持つ、最初の子ノードを取得する方法を解説します。

Dom\EntityReferenceクラスのfirstChildは、特定のエンティティ参照ノードの最初の子ノードを取得するためのプロパティです。このプロパティは引数を取らず、戻り値として子ノードを表すDom\Nodeオブジェクトを返します。もし子ノードが存在しない場合はnullを返します。

サンプルコードでは、まずDTD（文書型定義）で&author;というエンティティ（実体は文字列 "Taro Yamada"）を定義したXMLを読み込みます。次に、<author>要素の最初の子ノードであるエンティティ参照ノード&author;を取得します。

続いて、このエンティティ参照ノードに対してfirstChildプロパティを使用します。&author;の実体は "Taro Yamada" というテキストであるため、firstChildプロパティはそのテキストを表すDom\Textノードを返します。最後に、取得したテキストノードのクラス名と、nodeValueプロパティを使ってその内容である "Taro Yamada" を画面に出力しています。このように、エンティティ参照が持つ具体的な内容の先頭要素へアクセスできます。