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

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

作成日: 更新日:

基本的な使い方

localNameプロパティは、DOMNameSpaceNodeオブジェクトが表す名前空間ノードのローカル名(接頭辞を除いた名前)を保持するプロパティです。

DOMNameSpaceNodeは、XML名前空間を扱う際に使用されるノードの一種です。XML文書内で名前空間が定義されている場合、各要素や属性は特定の名前空間に属している可能性があります。この名前空間に属する要素や属性の名前は、通常、接頭辞とローカル名で構成されます(例:prefix:localName)。

localNameプロパティは、このローカル名部分、つまり接頭辞を除いた名前のみを取得するために使用されます。このプロパティにアクセスすることで、名前空間ノードが表す要素や属性の具体的な名前を知ることができます。

例えば、xmlns:hoge="http://example.com/hoge"という名前空間宣言があり、<hoge:fuga>...</hoge:fuga>という要素が存在する場合、hoge:fugaという要素に対応するDOMNameSpaceNodeオブジェクトのlocalNameプロパティはfugaという文字列を返します。

このプロパティは読み取り専用であり、値を変更することはできません。XML文書の構造や名前空間定義に基づいて自動的に決定されます。XML文書を解析し、名前空間を意識した処理を行うシステムを開発する際に、要素名や属性名を特定する目的で利用されます。システムエンジニアは、このプロパティを利用することで、XML文書から必要な情報を正確に抽出し、加工することができます。

構文(syntax)

1DOMNameSpaceNode::$localName;

引数(parameters)

戻り値(return)

string

DOMNameSpaceNode オブジェクトが表す名前空間のローカル名(接頭辞を除く部分)を文字列で返します。