【PHP8.x】localNameプロパティの使い方
localNameプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
localNameプロパティは、Dom\HTMLElementオブジェクトが表す要素のローカル名を保持するプロパティです。このプロパティは、HTMLドキュメントやXMLドキュメント内の特定の要素の名前空間プレフィックスを含まない部分、つまり「ローカル名」を取得するために使用されます。
XMLドキュメントにおいて、要素が名前空間プレフィックスを持つ場合、たとえば<prefix:elementName>という形式の要素では、localNameプロパティはそのプレフィックスを除いた「elementName」の部分を返します。これにより、同じローカル名を持つ要素が異なる名前空間に属していても、共通の識別子として扱うことが可能になります。
一方、HTMLドキュメントでは通常、要素に名前空間プレフィックスがありません。そのため、Dom\HTMLElementオブジェクトが表す<div>や<p>のようなHTML要素の場合、localNameプロパティは要素のタグ名そのもの、つまり「div」や「p」といった値を返します。
このプロパティを使用することで、要素がどの名前空間に属しているかに関わらず、その要素の基本的な名前を統一的に取得できます。特に、複雑なXML構造を解析する際や、HTML要素のタグ名を取得して処理を分岐させる際などに役立ちます。システムエンジニアを目指す初心者の方にとっては、HTML要素のタグ名を取得する基本的な方法の一つとして理解しておくと良いでしょう。
構文(syntax)
1<?php 2 3$dom = new DOMDocument(); 4$dom->loadHTML('<html><body><p id="example">テキスト</p></body></html>'); 5 6$element = $dom->getElementById('example'); 7 8// Dom\HTMLElement::localName プロパティへのアクセス 9echo $element->localName; 10 11?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
string
このプロパティは、要素のローカル名を文字列として返します。ローカル名とは、名前空間を考慮しない要素のタグ名のことです。