【PHP8.x】localNameプロパティの使い方
localNameプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
localNameプロパティは、DOMDocumentTypeクラスに属し、文書型宣言で指定されたルート要素の名前（ローカル名）を保持するプロパティです。PHPのDOM拡張機能は、XMLやHTMLドキュメントをオブジェクトとして扱い、その構造にプログラムからアクセス・操作することを可能にします。DOMDocumentTypeクラスは、これらのドキュメントの先頭にある文書型宣言（<!DOCTYPE ...>）に関する情報をカプセル化しています。
このlocalNameプロパティは、特にXMLドキュメントにおいて重要な概念である「名前空間」を考慮した上で、その要素のプレフィックス部分を除いた純粋な名前（ローカル名）を提供します。DOMDocumentTypeのコンテキストでは、文書型宣言によって定義されるドキュメントのルート要素のローカル名を文字列として取得できます。例えば、<!DOCTYPE html>という宣言があるHTMLドキュメントでは、このプロパティは"html"という値を返します。また、<!DOCTYPE mydocument SYSTEM "document.dtd">のようなXMLドキュメントでは、"mydocument"という値を返します。
システムエンジニアを目指す初心者の方にとって、localNameはドキュメントの型や構造をプログラム的に識別し、それに応じた処理を行う際に役立ちます。文書のルート要素名を正確に把握することで、特定のDTDに準拠しているかどうかの確認や、ドキュメントの特性に基づいた処理の分岐などを実現できます。このプロパティは読み取り専用であり、その値を変更することはできません。
構文(syntax)
1<?php 2$dom = new DOMDocument(); 3$dom->loadHTML('<!DOCTYPE html><html lang="en"><body><h1>Hello</h1></body></html>'); 4$documentType = $dom->doctype; 5$localName = $documentType->localName; 6?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
?string
DOMDocumentType クラスの localName プロパティは、このノードのローカル名を表す文字列、または名前空間プレフィックスがない場合は null を返します。