【PHP8.x】Dom\Attr::hasChildNodes()メソッドの使い方
hasChildNodesメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
hasChildNodesメソッドは、属性ノード（Dom\Attrオブジェクト）が子ノードを持っているかどうかを判定するメソッドです。このメソッドを呼び出すと、対象の属性ノードに子ノードが存在する場合にはtrueを、存在しない場合にはfalseを返します。DOMの構造において、属性ノードが持つ子ノードは、通常その属性の値を構成するテキストノードやエンティティ参照ノードです。したがって、このメソッドは実質的に、属性に値が設定されているかどうかを確認する目的で利用されることが多くなります。例えば、XMLやHTMLドキュメントを解析し、特定の要素から取得した属性オブジェクトに対してこのメソッドを実行することで、その属性が値を持たない空の属性なのか、あるいは何らかの値を持っているのかをプログラムで安全に判断できます。この判定結果を利用して、属性値の有無に応じた条件分岐処理を実装することが可能です。
構文(syntax)
1<?php 2 3$document = new DOMDocument(); 4$document->loadXML('<user id="123"></user>'); 5 6$element = $document->documentElement; 7$attributeNode = $element->getAttributeNode('id'); 8 9$result = $attributeNode->hasChildNodes(); 10 11var_dump($result); 12 13?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
bool
このメソッドは、ノードが子ノードを持っているかどうかを示す真偽値（bool）を返します。子ノードが存在すれば true を、存在しなければ false を返します。
サンプルコード
Dom\Attr::hasChildNodes()で子ノードの有無を確認する
1<?php 2 3// DOMDocumentオブジェクトを新しく作成します。 4$dom = new DOMDocument(); 5 6// HTML文字列をロードします。 7// ここでは、id属性とclass属性を持つシンプルなdiv要素を準備します。 8$htmlString = '<div id="exampleId" class="sampleClass">Hello DOM!</div>'; 9$dom->loadHTML($htmlString); 10 11// 'exampleId'というIDを持つ要素を取得します。 12$element = $dom->getElementById('exampleId'); 13 14if ($element) { 15 // 取得した要素から'id'属性のDom\Attrオブジェクトを取得します。 16 // Dom\Attrクラスのインスタンスは、DOMElement::attributesプロパティ（Dom\NamedNodeMap型）から 17 // getNamedItem()メソッドを使って取得するのが一般的です。 18 $idAttr = $element->attributes->getNamedItem('id'); 19 20 // 取得したオブジェクトがDom\Attrのインスタンスであることを確認します。 21 if ($idAttr instanceof Dom\Attr) { 22 // Dom\Attr::hasChildNodes()メソッドを呼び出し、この属性ノードが子ノードを持っているかを確認します。 23 // DOMの仕様では、Dom\Attrノードは通常、その属性値を示すテキストノードを子として持ちます。 24 $hasChildrenForId = $idAttr->hasChildNodes(); 25 26 // 結果を出力します。 27 // 'id="exampleId"'の場合、'exampleId'というテキストノードが子として存在するため、trueになります。 28 echo "属性 '{$idAttr->name}' (値: '{$idAttr->nodeValue}') は子ノードを持っていますか？: "; 29 echo ($hasChildrenForId ? 'はい' : 'いいえ') . PHP_EOL; 30 31 // 別の属性 'class' についても同様に確認してみます。 32 $classAttr = $element->attributes->getNamedItem('class'); 33 if ($classAttr instanceof Dom\Attr) { 34 $hasChildrenForClass = $classAttr->hasChildNodes(); 35 echo "属性 '{$classAttr->name}' (値: '{$classAttr->nodeValue}') は子ノードを持っていますか？: "; 36 echo ($hasChildrenForClass ? 'はい' : 'いいえ') . PHP_EOL; 37 } 38 } else { 39 echo "id属性が見つからないか、Dom\\Attr型ではありませんでした。\n"; 40 } 41} else { 42 echo "ID 'exampleId' の要素が見つかりませんでした。\n"; 43} 44
PHP 8のDom\Attr::hasChildNodes()メソッドは、DOM（Document Object Model）における属性ノードが子ノードを持っているかを確認するために使用されます。このメソッドは引数を取らず、戻り値としてbool型を返します。子ノードがあればtrue、なければfalseです。
HTML要素の属性（例えば<div id="exampleId">のid="exampleId")は、DOMの世界では「属性ノード」として扱われます。DOMの標準的な仕様では、これらの属性ノードは通常、その属性値（この例ではexampleId）を表現する「テキストノード」を子として持っています。そのため、有効な属性ノードに対してhasChildNodes()を呼び出すと、ほとんどの場合trueが返されます。
サンプルコードでは、DOMDocumentにロードされたHTMLからid属性とclass属性のDom\Attrオブジェクトを取得し、それぞれの属性が子ノードを持っているかを確認しています。id属性の「exampleId」やclass属性の「sampleClass」といった値がそれぞれテキストノードとして子に存在するため、いずれの確認でもtrueが出力されることがわかります。このメソッドは、属性ノードが実際に値を持つかどうかを間接的に判定する際などに役立ちます。
Dom\Attr::hasChildNodes()は、特定の属性ノードが子ノードを持つかどうかを真偽値で判定するメソッドです。DOMの仕様では、Dom\Attrノードはその属性値（例: id="exampleId"のexampleId部分）をテキストノードとして子に持つため、このメソッドはほとんどの場合trueを返します。
サンプルコードのように、属性ノードはDOMElement::attributesプロパティからgetNamedItem()メソッドを使って取得します。この際、getElementById()やgetNamedItem()は対象が見つからない場合にnullを返す可能性があります。そのため、取得した要素や属性がnullでないか、そしてinstanceof Dom\Attrで期待通りの型であるかを必ず確認してからメソッドを呼び出すようにしてください。このチェックを行うことで、プログラムの実行時エラーを防ぎ、より安全で堅牢なコードになります。
PHP Dom\Attr hasChildNodes() を使う
1<?php 2 3// DOMDocument を作成します。これはHTMLやXMLドキュメントを表現するためのオブジェクトです。 4// 第二引数でエンコーディングを指定します。 5$dom = new DOMDocument('1.0', 'UTF-8'); 6 7// HTMLのルート要素として <body> を作成し、ドキュメントに追加します。 8$body = $dom->createElement('body'); 9$dom->appendChild($body); 10 11// <p> 要素を作成し、テキストノードを追加してから <body> に追加します。 12$paragraph = $dom->createElement('p', 'これはサンプルテキストです。'); 13$body->appendChild($paragraph); 14 15// <p> 要素にいくつかの属性を追加します。 16// Dom\Attr::hasChildNodes() は、その属性が値（テキストノード）を持っているかを確認します。 17 18// 1. 通常の値をを持つ属性を追加 19// この属性は 'mainParagraph' というテキスト値を子ノードとして持ちます。 20$paragraph->setAttribute('id', 'mainParagraph'); 21 22// 2. 空の値を明示的に持つ属性を追加 23// 空文字列でもテキストノードとして扱われるため、この属性も子ノードを持つと判断されます。 24$paragraph->setAttribute('data-example', ''); 25 26// 3. 値が省略された属性を追加 (HTML5のブール属性のように) 27// PHPのDOM拡張では、値が指定されない属性も内部的には空文字列が割り当てられます。 28// そのため、これも子ノードを持つと判断されます。 29$paragraph->setAttribute('hidden'); 30 31// ここから Dom\Attr::hasChildNodes() メソッドを使って、各属性の子ノードの有無をチェックします。 32 33// 'id' 属性の Dom\Attr オブジェクトを取得 34$idAttr = $paragraph->attributes->getNamedItem('id'); 35if ($idAttr instanceof Dom\Attr) { 36 // hasChildNodes() は属性値のテキストノードが存在すれば true を返します。 37 echo "属性 'id' (値: '" . $idAttr->nodeValue . "'): "; 38 echo $idAttr->hasChildNodes() ? "子ノードあり (true)\n" : "子ノードなし (false)\n"; // 結果: true 39} 40 41// 'data-example' 属性の Dom\Attr オブジェクトを取得 42$dataExampleAttr = $paragraph->attributes->getNamedItem('data-example'); 43if ($dataExampleAttr instanceof Dom\Attr) { 44 // 空文字列であっても、テキストノード自体は存在するため true を返します。 45 echo "属性 'data-example' (値: '" . $dataExampleAttr->nodeValue . "'): "; 46 echo $dataExampleAttr->hasChildNodes() ? "子ノードあり (true)\n" : "子ノードなし (false)\n"; // 結果: true 47} 48 49// 'hidden' 属性の Dom\Attr オブジェクトを取得 50$hiddenAttr = $paragraph->attributes->getNamedItem('hidden'); 51if ($hiddenAttr instanceof Dom\Attr) { 52 // 値が省略されていても、DOMでは空のテキストノードが内部的に作成されるため true を返します。 53 echo "属性 'hidden' (値: '" . $hiddenAttr->nodeValue . "'): "; 54 echo $hiddenAttr->hasChildNodes() ? "子ノードあり (true)\n" : "子ノードなし (false)\n"; // 結果: true 55} 56 57// 存在しない属性の場合の確認 58// getNamedItem() は、存在しない属性の場合に null を返します。 59$nonExistentAttr = $paragraph->attributes->getNamedItem('class'); 60if ($nonExistentAttr instanceof Dom\Attr) { 61 echo "属性 'class' (存在しない): 子ノードあり/なしのチェックを試行\n"; 62 // このブロックは実行されません。 63} else { 64 echo "属性 'class' (存在しない): 属性オブジェクトが見つかりません (null)\n"; 65} 66 67// 実行結果例: 68// 属性 'id' (値: 'mainParagraph'): 子ノードあり (true) 69// 属性 'data-example' (値: ''): 子ノードあり (true) 70// 属性 'hidden' (値: ''): 子ノードあり (true) 71// 属性 'class' (存在しない): 属性オブジェクトが見つかりません (null)
このサンプルコードは、PHPのDOM拡張機能におけるDom\AttrクラスのhasChildNodes()メソッドの使い方を示しています。このメソッドは、HTMLやXMLの要素に設定された「属性」が、何らかの「子ノード」を持っているかどうかを確認するために使用されます。引数はなく、属性に子ノードが存在すればtrue、存在しなければfalseを真偽値（bool）として返します。
コードではまず、DOMDocumentを作成し、<body>や<p>といったHTML要素とその属性を追加しています。具体的には、id="mainParagraph"のように値が設定された属性、data-example=""のように値が空文字列である属性、そしてhiddenのように値が省略された属性（ブール属性）を作成しています。
Dom\Attr::hasChildNodes()メソッドは、これらの属性の子ノードの有無をチェックします。PHPのDOM拡張では、属性の値は「テキストノード」として扱われます。したがって、id属性のように明確な値を持つ場合はもちろん、data-example属性のように値が空文字列の場合や、hidden属性のように値が省略されている場合でも、内部的には空のテキストノードが存在すると判断されるため、hasChildNodes()はtrueを返します。これは、属性に「値がない」ことと「子ノードがない」ことは区別されるためです。存在しない属性に対してはこのメソッドを呼び出すこと自体ができず、属性オブジェクトが見つからないことを確認できます。
このメソッドを使うことで、プログラム的に属性の値を詳細に検査し、その状態に応じて処理を分岐させることが可能になります。
Dom\Attr::hasChildNodes()は、属性がテキストノードを子に持つかを確認します。初心者が特に注意すべきは、属性値が空文字列の場合や、HTML5のブール属性のように値が省略された場合でも、PHPのDOM拡張では内部的に空のテキストノードが作成されるため、このメソッドがtrueを返す点です。したがって、「属性に具体的な値が存在するか」をチェックしたい場合は、$attr->nodeValue !== ''のような値そのものの確認も併用することをお勧めします。また、属性オブジェクトはgetNamedItem()で取得しますが、指定した属性が存在しない場合はnullが返されます。そのため、メソッドを呼び出す前には必ずif ($idAttr instanceof Dom\Attr)のように、属性オブジェクトが正しく取得できたかを確認してから利用してください。この確認を怠ると、予期せぬエラーの原因となります。jQueryの同名メソッドとは動作が異なる場合がありますので、混同しないよう注意が必要です。