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

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

作成日: 更新日:

基本的な使い方

firstChildプロパティは、HTMLやXMLドキュメントの構造を表すDOM(Document Object Model)において、あるノードの最初の子ノードを保持するプロパティです。特に、このプロパティが所属するDOMAttrクラスは、HTMLタグのid="example"class="item"といった属性そのものを表現するために用いられます。

通常、DOMの要素ノードなどでは、その内部に含まれるテキストノードや他の子要素ノードにアクセスするためにfirstChildプロパティが利用されます。しかし、DOMAttrクラスのインスタンスにおいてはこのfirstChildプロパティは常にnullを返します。これは、DOMの標準的な定義に基づき、属性ノードが子ノードを持つ構造ではないためです。属性の値は、属性ノード自体が保持する単一の文字列データとして扱われます。

したがって、DOMAttrオブジェクトが表す属性の具体的な値を参照したい場合には、firstChildプロパティではなく、nodeValueプロパティを利用する必要があります。nodeValueプロパティは、その属性に設定されている実際の値を文字列として正確に提供します。システムエンジニアを目指す初心者の皆様は、DOMAttrのfirstChildが常にnullを返す点、そして属性値の取得にはnodeValueプロパティを用いる点を理解しておくことが重要です。

構文(syntax)

1<?php
2
3// DOMAttr オブジェクトの準備
4$dom = new DOMDocument();
5$dom->loadXML('<element myattr="attribute value"></element>');
6$element = $dom->getElementsByTagName('element')->item(0);
7$attributeNode = $element->getAttributeNode('myattr');
8
9// DOMAttr::firstChild プロパティへのアクセス
10if ($attributeNode) {
11    $firstChildOfAttribute = $attributeNode->firstChild;
12
13    if ($firstChildOfAttribute) {
14        echo "属性の最初の子ノードの値: " . $firstChildOfAttribute->nodeValue; // 出力: attribute value
15    } else {
16        echo "この属性には子ノードがありません。";
17    }
18}
19
20?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

DOMNode|null

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

サンプルコード

PHP DOMAttr firstChild プロパティで子ノードを確認する

1<?php
2
3// DOMAttr の firstChild プロパティのサンプルコード
4
5// DOMDocument オブジェクトを作成
6$dom = new DOMDocument();
7
8// XML ドキュメントをロード
9$dom->loadXML('<root><element attribute="value">text</element></root>');
10
11// element 要素を取得
12$element = $dom->getElementsByTagName('element')->item(0);
13
14// attribute 属性を取得
15$attribute = $element->getAttributeNode('attribute');
16
17// firstChild プロパティを使用して、最初の子ノードを取得
18// DOMAttr には子ノードは存在しないため、常に null が返ります。
19$firstChild = $attribute->firstChild;
20
21// 結果を出力
22if ($firstChild === null) {
23    echo "firstChild is null.\n";
24} else {
25    echo "firstChild is not null.\n";
26}
27
28?>

PHPのDOMAttrクラスにおけるfirstChildプロパティについて解説します。このプロパティは、属性ノード(DOMAttrオブジェクト)の最初の子ノードを取得するために使用されます。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、XMLドキュメントをロードしています。次に、getElementsByTagNameメソッドで "element" というタグ名の要素を取得し、getAttributeNodeメソッドで "attribute" という名前の属性ノードを取得しています。

ここで重要なのは、DOMAttrオブジェクトは属性ノードを表しており、属性ノード自体は子ノードを持ちません。そのため、firstChildプロパティにアクセスすると、常に null が返されます。

サンプルコードでは、取得した属性ノードのfirstChildプロパティにアクセスし、その結果が null であるかどうかをチェックしています。結果は必ず null となるため、「firstChild is null.」というメッセージが出力されます。

つまり、DOMAttr->firstChild は、属性ノードが子ノードを持つことがないため、常に null を返すということを理解しておく必要があります。属性ノードの内容にアクセスしたい場合は、nodeValueプロパティを使用します。

DOMAttr クラスの firstChild プロパティは、属性ノードの最初の子ノードを取得するものですが、DOMAttr は属性そのものを表すため、子ノードを持ちません。したがって、このプロパティは常に null を返します。サンプルコードでは、この点を明確にするために、firstChildnull であることを確認しています。初心者は、DOMAttr が他のノードタイプ(DOMElement など)とは異なり、子ノードを持たないことを理解しておく必要があります。属性の値にアクセスするには、value プロパティを使用します。

PHP DOM firstChild で属性の子ノードを取得する

1<?php
2
3// DOMAttr の firstChild プロパティのサンプルコード
4
5// 新しい DOMDocument オブジェクトを作成します。
6$dom = new DOMDocument();
7
8// 属性を持つ要素を作成します。
9$element = $dom->createElement('test');
10$attribute = $dom->createAttribute('myattr');
11$attribute->value = 'somevalue';
12$element->setAttributeNode($attribute);
13
14// 要素をドキュメントに追加します。
15$dom->appendChild($element);
16
17// 属性ノードを取得します。
18$attrNode = $element->getAttributeNode('myattr');
19
20// firstChild プロパティを使用して、属性ノードの最初の子ノードを取得します。
21// DOMAttr は属性ノードを表し、属性ノードはテキストノード(属性値)を子として持つことがあります。
22$firstChild = $attrNode->firstChild;
23
24// 最初の子ノードが存在するかどうかを確認します。
25if ($firstChild !== null) {
26  // 最初の子ノードの値を表示します。
27  echo "属性 'myattr' の最初の子供の値: " . $firstChild->nodeValue . PHP_EOL;
28} else {
29  echo "属性 'myattr' には子供がいません。" . PHP_EOL;
30}
31
32?>

このサンプルコードは、PHPのDOM拡張を用いて、DOMAttrクラスのfirstChildプロパティの動作を示しています。DOMAttrはXML属性を表すクラスです。firstChildプロパティは、その属性ノードの最初の子ノードを返します。属性値はテキストノードとして表現されるため、firstChildは通常、属性の値を表すDOMTextノードを返します。

まず、DOMDocumentオブジェクトを作成し、属性myattrを持つ要素testを作成します。そして、setAttributeNodeメソッドを使って属性を要素に追加し、ドキュメントに要素を追加します。

次に、getAttributeNodeメソッドで属性ノードを取得し、firstChildプロパティにアクセスします。firstChildプロパティはDOMNode型またはnullを返します。もし属性ノードが子ノードを持つ場合、最初の子ノード(通常は属性値を表すテキストノード)が返されます。子ノードが存在しない場合はnullが返されます。

サンプルコードでは、firstChildnullでないことを確認し、存在する場合はその値(nodeValueプロパティ)を表示します。もしnullであれば、属性に子ノードが存在しないことを示すメッセージを表示します。この例では、属性myattrsomevalueが設定されているため、firstChildsomevalueというテキストノードを指し、その値が表示されます。

DOMAttrfirstChildは、属性ノード(DOMAttrオブジェクト)が持つ最初の子ノードを返します。属性値がテキストの場合、テキストノード(DOMTextオブジェクト)が返されます。もし属性値が空の場合や、属性ノードが子ノードを持たない場合はnullを返します。firstChildを使う前に、属性が存在することを確認しましょう。また、返り値がnullでないことを確認してから、nodeValueプロパティにアクセスするようにしてください。これにより、予期せぬエラーを回避できます。属性値を取得する簡単な方法としてDOMElement::getAttribute()メソッドの利用も検討してください。

【PHP8.x】firstChildプロパティの使い方 | いっしー@Webエンジニア