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

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

作成日: 2025年09月11日更新日: 2025年12月05日

基本的な使い方

nodeNameプロパティは、所属するDOMEntityが表すエンティティの名前を文字列として保持するプロパティです。

DOMEntityクラスは、XMLドキュメントのドキュメント型定義（DTD）において定義される「エンティティ」を表します。エンティティとは、例えばHTMLでよく使われる「」のような特殊文字の記号（文字実体参照）や、外部ファイルの内容をXML文書内に埋め込むための参照（外部エンティティ）などを指します。

このnodeNameプロパティは、それらのエンティティを識別するための名前を提供します。例えば、DTDに「<!ENTITY nbsp " ">」というエンティティが定義されている場合、そのDOMEntityオブジェクトのnodeNameプロパティは「"nbsp"」という文字列を返します。同様に、「<!ENTITY logo SYSTEM "logo.gif" NDATA gif>」のような外部エンティティの場合も、nodeNameプロパティは「"logo"」という文字列を返します。

このプロパティは読み取り専用であり、その値をプログラムから変更することはできません。主に、XMLドキュメントの構造を解析し、含まれるエンティティの種類を特定したり、特定のエンティティに対する処理を分岐させたりする際に利用されます。システムエンジニアはnodeNameプロパティを利用することで、ドキュメント内のエンティティ情報を効率的に扱うことができます。

構文(syntax)


1<?php
2
3$xmlString = <<<XML
4<?xml version="1.0" encoding="UTF-8"?>
5<!DOCTYPE root [
6  <!ENTITY myEntity "entityValue">
7]>
8<root>&myEntity;</root>
9XML;
10
11$doc = new DOMDocument();
12$doc->loadXML($xmlString);
13
14// 'myEntity' という名前の DOMEntity オブジェクトを取得します
15$entity = $doc->doctype->entities->getNamedItem('myEntity');
16
17// DOMEntity の nodeName プロパティはエンティティ名を返します
18echo $entity->nodeName; // 出力: myEntity
19
20?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

DOMEntityオブジェクトのノード名を文字列として取得します。このノード名は、エンティティ名をそのまま表します。

サンプルコード

PHP DOMDocument nodenameでエンティティ名を取得する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMEntityのnodeNameプロパティの使用例を示します。
7 *
8 * この関数は、DTD(文書型定義)を含むXMLを解析し、
9 * 定義されている各エンティティのnodeName（エンティティ名）を取得して表示します。
10 */
11function displayEntityNodeNames(): void
12{
13    // DTDで 'writer' と 'copyright' という2つのエンティティを定義したXML文字列。
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<!DOCTYPE note [
17  <!ENTITY writer "Taro Yamada">
18  <!ENTITY copyright "Copyright 2023">
19]>
20<note>
21  <content>This is a sample note.</content>
22  <footer>&writer; &copyright;</footer>
23</note>
24XML;
25
26    // DOMDocumentオブジェクトをインスタンス化します。
27    $dom = new DOMDocument();
28
29    // XML文字列を読み込み、解析します。
30    $dom->loadXML($xmlString);
31
32    // 文書型(DOMDocumentType)オブジェクトを取得します。
33    // DTDの情報はここに含まれています。
34    $docType = $dom->doctype;
35
36    // DTDにエンティティが含まれているか確認します。
37    // $docType->entitiesは、エンティティ(DOMEntity)を格納したDOMNamedNodeMapです。
38    if ($docType && $docType->entities->length > 0) {
39        echo "DTDで定義されたエンティティのnodeName:" . PHP_EOL;
40
41        // すべてのエンティティをループ処理します。
42        // $entityはDOMEntityオブジェクトです。
43        foreach ($docType->entities as $entity) {
44            // DOMEntityのnodeNameプロパティは、エンティティの名前を文字列で返します。
45            // この例では 'writer' と 'copyright' が出力されます。
46            echo '- ' . $entity->nodeName . PHP_EOL;
47        }
48    } else {
49        echo 'エンティティが見つかりませんでした。' . PHP_EOL;
50    }
51}
52
53// 関数を実行して結果を表示します。
54displayEntityNodeNames();

このサンプルコードは、PHPのDOMEntityクラスが持つnodeNameプロパティの使用方法を解説するものです。このプロパティは、XML文書内で定義されたエンティティの名前を取得するために使われます。

コードではまず、DOMDocumentオブジェクトを生成し、loadXML()メソッドを使ってDTD（文書型定義）を含むXML文字列を読み込み、解析します。このXMLデータには、writerとcopyrightという2つのエンティティが事前に定義されています。

次に、DOMDocumentオブジェクトのdoctypeプロパティから文書型定義の情報にアクセスし、さらにその中のentitiesプロパティによって定義済みの全エンティティの一覧を取得します。この一覧に含まれる各エンティティはDOMEntityオブジェクトとして扱われます。

ループ処理の中で、各DOMEntityオブジェクトのnodeNameプロパティを参照しています。このnodeNameプロパティは引数を取らず、戻り値としてエンティティ名を文字列(string)で返します。このコードでは、nodeNameプロパティが返す値、つまりエンティティ名であるwriterとcopyrightが順に出力されます。このように、nodeNameプロパティはXMLのエンティティ名を特定する際に役立ちます。

DOMEntityのnodeNameプロパティは、エンティティの「名前」を文字列で取得します。エンティティに設定された「値」（例: "Taro Yamada"）を取得するものではない点に注意してください。エンティティはXMLのDTD（文書型定義）で定義されるため、DOMDocumentオブジェクトのdoctypeプロパティからアクセスします。XMLデータにDTDやエンティティ定義が存在しない場合、doctypeプロパティやentitiesがnullや空になることがあります。そのため、サンプルコードのようにif文で存在を確認してから利用することが、エラーを防ぐために重要です。また、このnodeNameプロパティは読み取り専用であり、値を代入してエンティティ名を変更することはできません。