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

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

作成日: 更新日:

基本的な使い方

nodeNameプロパティは、DOM (Document Object Model) 拡張機能の一部であるDom\Entityクラスに属し、ノードの名前を文字列として保持するプロパティです。

Dom\Entityクラスは、XML文書内で定義されるエンティティ(実体参照)ノードを表します。エンティティとは、特定の文字列や構造を短い名前で参照できるようにする仕組みです。

このnodeNameプロパティは、Dom\Entityオブジェクトが表すエンティティの名前を、読み取り専用の文字列として提供します。具体的には、XMLの<!ENTITY name "value">といった宣言で指定された「name」の部分を返します。例えば、<!ENTITY copyright "Copyright 2023"> というエンティティが定義されている場合、対応するDom\EntityオブジェクトのnodeNameプロパティは "copyright" という文字列を保持します。

nodeNameプロパティは、DOMツリーを走査する際に、現在処理しているノードがどのような種類のエンティティであるかを識別するために非常に有用です。ノードのタイプを判別して特定の処理を実行したり、特定の名前を持つエンティティを探したりする目的で利用されます。このプロパティは読み取り専用であるため、その値を直接変更することはできません。

構文(syntax)

1<?php
2$document = new DOMDocument();
3$document->loadXML('<!DOCTYPE root [<!ENTITY myentity "Entity Content">]><root/>');
4
5$entity = $document->doctype->entities->getNamedItem('myentity');
6
7if ($entity instanceof DOMEntity) {
8    echo $entity->nodeName;
9}
10?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このnodeNameプロパティは、DOMノードの名前を表す文字列を返します。例えば、要素ノードの場合はタグ名(例: "div")を、属性ノードの場合は属性名(例: "id")を返します。

関連コンテンツ

関連プログラミング言語