【PHP8.x】Dom\Entity::firstChildプロパティの使い方
firstChildプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
firstChildプロパティは、Dom\Entityクラスが表すXMLエンティティの、最初の子ノードを保持するプロパティです。
このプロパティは、XMLドキュメントをツリー構造で扱うDOM（Document Object Model）という仕組みにおいて、特定のエンティティが持つ直下の最初の子要素やテキストノードにアクセスするために利用されます。Dom\Entityは、XMLのDOCTYPE宣言などで定義されるエンティティ（例えば、繰り返し使用されるテキストやマークアップの断片）を表します。
具体的には、このプロパティはDom\Node型のオブジェクトを返します。返されるDom\Nodeは、要素ノード、テキストノード、コメントノードなど、様々な種類のノードである可能性があります。これにより、エンティティの内容の構造をプログラムから詳細に調べることが可能になります。
もし、対象のDom\Entityに子ノードが一つも存在しない場合、firstChildプロパティはnullを返します。この挙動を考慮して、プログラムを安全に記述することが重要です。
firstChildプロパティは、XMLドキュメントの特定のエンティティに含まれる情報を抽出し、その内部構造を解析したり、必要に応じて加工したりする際に非常に役立ちます。例えば、エンティティの定義内容を読み込み、その最初の子要素の属性値やテキストコンテンツを取得するといった処理に活用できます。DOMツリーを効率的に走査し、目的のデータにたどり着くための起点となるため、XMLデータの処理を行うシステム開発において基本的ながらも重要な機能を提供します。
構文(syntax)
1<?php 2// DTDを含むXML文書を作成し、Dom\Entityオブジェクトを取得します。 3$xmlString = '<!DOCTYPE root [<!ENTITY myEntity "Hello PHP!">]><root/>'; 4$dom = new DOMDocument(); 5$dom->loadXML($xmlString); 6 7$doctype = $dom->doctype; 8$entity = null; 9if ($doctype && $doctype->entities) { 10 $entity = $doctype->entities->getNamedItem('myEntity'); 11} 12 13if ($entity) { 14 // Dom\Entity::firstChild プロパティは、エンティティの内容の最初のDOMノードを返します。 15 $firstNode = $entity->firstChild; 16 17 // $firstNode は Dom\Node のインスタンス、または子ノードがない場合は null です。 18 if ($firstNode) { 19 echo $firstNode->nodeValue; // 結果例: "Hello PHP!" 20 } 21}
引数(parameters)
引数なし
引数はありません
戻り値(return)
Dom\Node|null
このプロパティは、要素の最初の子ノードを返します。子ノードが存在しない場合は null を返します。
サンプルコード
PHP DOMDocument firstChild で最初の子ノードを取得する
1<?php 2 3/** 4 * DOM要素の最初の子ノードを取得するサンプル関数 5 * 6 * firstChildプロパティは、指定したノードの最初の子ノードを取得します。 7 * 子ノードが存在しない場合は null を返します。 8 * 9 * @return void 10 */ 11function showFirstChildExample(): void 12{ 13 // 操作対象のXML文字列を定義します。 14 // <book>要素には、<title>と<author>という2つの子要素があります。 15 $xmlString = '<book><title>PHP実践入門</title><author>専門家</author></book>'; 16 17 // DOMDocumentオブジェクトをインスタンス化します。 18 $doc = new DOMDocument(); 19 20 // XML文字列を読み込みます。 21 $doc->loadXML($xmlString); 22 23 // ドキュメントのルート要素(<book>)を取得します。 24 // $doc->documentElement はドキュメントのルート要素を指すプロパティです。 25 $bookElement = $doc->documentElement; 26 27 // <book>要素の最初の子ノード(firstChild)を取得します。 28 // この場合、最初の子ノードは <title> 要素です。 29 $firstChildNode = $bookElement->firstChild; 30 31 // firstChild が存在するかチェックします (子ノードがない場合は null が返るため)。 32 if ($firstChildNode !== null) { 33 // 取得したノードの情報を出力します。 34 // nodeName は要素名 (title)、nodeValue (または textContent) はその要素が持つテキストコンテンツです。 35 echo '親要素のノード名: ' . $bookElement->nodeName . PHP_EOL; 36 echo '最初の子ノード名: ' . $firstChildNode->nodeName . PHP_EOL; 37 echo '最初の子ノードの値: ' . $firstChildNode->textContent . PHP_EOL; 38 } else { 39 echo $bookElement->nodeName . ' には子ノードがありません。' . PHP_EOL; 40 } 41} 42 43// 関数を実行して結果を表示します。 44showFirstChildExample(); 45 46?>
PHPのfirstChildは、特定のDOMノード（HTMLやXMLの要素など）が持つ子ノードの中から、最初のひとつを取得するためのプロパティです。このプロパティには引数は必要ありません。
サンプルコードでは、まずDOMDocumentオブジェクトを生成し、XML文字列を読み込んでいます。$doc->documentElementによって、XML文書のルート要素である<book>要素を取得します。次に、この<book>要素に対してfirstChildプロパティを使用することで、その最初の子ノードである<title>要素を取得しています。
firstChildプロパティは、子ノードが存在する場合にはそのノードを表すDOMNodeオブジェクトを返します。もし子ノードが一つも存在しない場合はnullを返します。そのため、サンプルコードのようにif文でnullでないことを確認してから、取得したノードのnodeName（要素名）やtextContent（テキスト内容）といった情報を取り出して利用するのが安全な使い方です。このようにfirstChildは、階層構造の中から特定の子要素へアクセスする際の基本的な操作として利用されます。
firstChild プロパティは、子ノードが存在しない場合に null を返すため、必ず使用前に null でないかを確認する処理が必要です。この確認を怠ると、存在しないオブジェクトにアクセスしようとしてエラーが発生する原因となります。また、XML内の改行やインデントなどの空白は、テキストノードとして解釈されることがあります。そのため、firstChild が意図した要素ノードではなく、空白のテキストノードを指してしまう可能性がある点に注意してください。ノード内のテキスト内容を安全に取得するには、サンプルコードのように textContent プロパティを使用するのが確実です。