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

firstChildプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年12月05日

基本的な使い方

firstChildプロパティは、DOMEntityが表す実体の内容における最初の「子ノード」を保持するプロパティです。

DOMEntityクラスは、XMLやHTMLなどのマークアップ言語において「実体（エンティティ）」と呼ばれる特別な要素を表します。実体とは、例えば頻繁に使う文字列、特殊文字、あるいは外部ファイルの参照などを簡潔に定義し、ドキュメント内で再利用するための仕組みです。

このfirstChildプロパティは、そのDOMEntityが定義する内容、つまりエンティティが展開された結果として生成されるノード群の中で、最上位かつ最初のノードへの参照を提供します。例えば、あるXMLエンティティが「<paragraph>これは<b>最初の</b>段落です</paragraph><paragraph>次の段落です</paragraph>」というXML断片を定義している場合、firstChildプロパティは「<paragraph>これは<b>最初の</b>段落です</paragraph>」に対応するDOMNodeオブジェクトを返します。

もしDOMEntityが表す実体の内容が空であるか、あるいは有効な子ノードを持たない場合は、このプロパティはnullを返します。返される値の型は、常にDOMNodeオブジェクトかnullのいずれかです。

このプロパティは読み取り専用であり、直接内容を書き換えることはできません。エンティティ参照が実際にドキュメント内で展開された際に、その参照が指すコンテンツの最初のノードを取得するために非常に役立ちます。システムエンジニアとしてXML設定ファイルやデータファイルの内容をPHPで解析する際、特に複雑な構造を持つエンティティの内容をプログラムで探索したり、特定の情報を抽出したりする場面で、このfirstChildプロパティが最初の入り口となるノードを見つけるために利用されます。これはPHPのDOM拡張機能におけるXMLドキュメントの構造を理解し、その内容にアクセスするための基本的な要素の一つです。

構文(syntax)


1<?php
2
3$xmlString = <<<XML
4<!DOCTYPE root [
5    <!ENTITY myEntity "entityValue">
6]>
7<root>&myEntity;</root>
8XML;
9
10$doc = new DOMDocument();
11$doc->loadXML($xmlString);
12
13// 'myEntity' という名前の DOMEntity オブジェクトを取得
14$entity = $doc->doctype->entities->getNamedItem('myEntity');
15
16// DOMEntity::$firstChild プロパティにアクセスする
17// (DOMEntity は子ノードを持つことができないため、このプロパティは常に null です)
18$firstChildNode = $entity->firstChild;
19
20var_dump($firstChildNode);
21
22?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

DOMNode|null

DOMEntityオブジェクトの最初の子ノードをDOMNodeオブジェクトとして返します。子ノードが存在しない場合はnullを返します。

サンプルコード

php DOMDocument firstChildでエンティティの子ノードを取得する


1<?php
2
3/**
4 * DOMEntityのfirstChildプロパティの使用例を示します。
5 *
6 * DTDで定義されたエンティティノードを取得し、その最初の子ノード
7 * (この場合はエンティティの置換テキストであるDOMTextノード) の内容を表示します。
8 */
9function showEntityFirstChild(): void
10{
11    // DTD (文書型定義) を含むXML文字列を定義します。
12    // ここでは 'company' という名前のエンティティを定義しています。
13    $xmlString = <<<XML
14<?xml version="1.0" encoding="utf-8"?>
15<!DOCTYPE document [
16  <!ENTITY company "Example Inc.">
17]>
18<document>
19  <copyright>&company;</copyright>
20</document>
21XML;
22
23    // DOMDocumentオブジェクトをインスタンス化します。
24    $dom = new DOMDocument();
25
26    // XML文字列を読み込みます。
27    $dom->loadXML($xmlString);
28
29    // DocumentTypeノード (<!DOCTYPE ...> の部分) を取得します。
30    $doctype = $dom->doctype;
31
32    // DocumentTypeノードが存在し、エンティティが定義されているか確認します。
33    if ($doctype && $doctype->entities) {
34        // 'company' という名前のエンティティ (DOMEntity) を取得します。
35        $entity = $doctype->entities->getNamedItem('company');
36
37        if ($entity instanceof DOMEntity) {
38            // DOMEntityのfirstChildプロパティにアクセスします。
39            // この場合、"Example Inc." というテキストを持つDOMTextノードが返ります。
40            $firstChild = $entity->firstChild;
41
42            // firstChildがnullでないことを確認します。
43            if ($firstChild instanceof DOMNode) {
44                // firstChildのnodeValue（テキストの内容）を出力します。
45                echo "エンティティ 'company' の firstChild の値: " . $firstChild->nodeValue . PHP_EOL;
46            } else {
47                echo "エンティティ 'company' には子ノードがありません。" . PHP_EOL;
48            }
49        } else {
50            echo "エンティティ 'company' が見つかりません。" . PHP_EOL;
51        }
52    } else {
53        echo "DTDまたはエンティティが見つかりません。" . PHP_EOL;
54    }
55}
56
57// 関数を実行して結果を表示します。
58showEntityFirstChild();

このサンプルコードは、PHPのDOMEntityクラスが持つfirstChildプロパティの使用方法を示しています。このプロパティは、DTD（文書型定義）で定義されたエンティティの最初の子ノードを取得するために使用します。引数はなく、戻り値として子ノードが存在すればDOMNodeオブジェクトを、存在しなければnullを返します。

コードでは、まず<!ENTITY company "Example Inc.">というエンティティ定義を含むXML文字列を用意します。次に、DOMDocumentオブジェクトでこのXMLを解析し、doctypeプロパティからDTDの情報を取得します。そして、entitiesプロパティとgetNamedItem('company')メソッドを使い、companyという名前のエンティティを表すDOMEntityオブジェクトを取得します。

$entity->firstChildと記述することで、このエンティティの最初の子ノードにアクセスします。この例では、エンティティの置換テキストである「Example Inc.」がDOMTextノードとして扱われ、それがfirstChildとして取得されます。最後に、取得したノードのnodeValueプロパティ（ノードが持つテキスト値）を出力し、エンティティの内容が正しく取得できたことを確認しています。

firstChildプロパティは、子ノードが存在しない場合にnullを返すため、利用する前に必ずnullチェックを行う必要があります。チェックを怠ると、nullに対してプロパティ（例: nodeValue）へアクセスしようとしてエラーが発生します。このサンプルコードにおけるDOMEntityのfirstChildは、DTDで定義されたエンティティの置換テキストを表すDOMTextノードです。子ノードは必ずしもHTMLタグのような要素ノードではない点に注意してください。また、このコードはXML文書内にDTDと対象のエンティティが正しく定義されていることが前提です。定義が存在しない場合、期待通りに動作しません。