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

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

作成日: 更新日:

基本的な使い方

localNameプロパティは、XML名前空間を利用する際に、ノードの名前空間接頭辞(プレフィックス)を含まないローカルな名前部分を保持するプロパティです。PHPのDOM拡張機能は、XMLやHTMLドキュメントの構造をプログラムから操作するための機能を提供します。このlocalNameプロパティは、すべてのノードの基底クラスであるDOMNodeクラスで定義されており、DOMCharacterDataクラスがDOMNodeクラスを継承しているため、DOMCharacterDataクラスのインスタンスからも利用できます。

しかしながら、DOMCharacterDataクラスは、ドキュメント内のテキストデータ、コメント、CDATAセクションといった、文字情報のみを扱う抽象的なノードを表します。これらのノードタイプは、HTMLの<div>やXMLの<book>のような「要素名」を持たないため、localNameプロパティの値は常にnullとなります。localNameプロパティが具体的な意味を持つのは、主にDOMElementのような要素ノードの場合です。例えば、XMLドキュメントで<prefix:tag>という要素が存在する場合、DOMElementのインスタンスからlocalNameプロパティを参照するとtagという文字列が得られます。したがって、DOMCharacterDataの子孫クラス(DOMTextDOMCommentDOMCDataSectionなど)のノードに対してlocalNameプロパティを参照しても、有用な情報は得られない点にご留意ください。

構文(syntax)

1<?php
2$document = new DOMDocument();
3$textNode = $document->createTextNode("Example Text");
4echo $textNode->localName;
5?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

?string

DOMCharacterDataクラスのlocalNameプロパティは、ノードのローカル名を表す文字列、またはローカル名を持たない場合はnullを返します。

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