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

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

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

基本的な使い方

nodeNameプロパティは、エンティティ参照ノードの名前を文字列として保持するプロパティです。このプロパティは、XMLやHTML文書をプログラムで操作する際に、エンティティ参照（例: & や < など）を表すDOMEntityReferenceオブジェクトに対して使用されます。nodeNameプロパティにアクセスすると、そのエンティティ参照の名前が返されます。例えば、文書内に©というエンティティ参照がある場合、対応するノードのnodeNameプロパティは、アンパサンド（&）やセミコロン（;）を含まない文字列 "copy" を返します。このプロパティは読み取り専用であるため、プログラムによって値を変更することはできません。文書構造を解析する過程で、特定のエンティティ参照を識別し、その種類に応じて処理を分岐させたい場合などに役立ちます。このように、nodeNameプロパティは、DOMツリー内のエンティティ参照ノードがどのエンティティを指しているのかを、名前によって正確に特定するための重要な手段となります。

構文(syntax)


1<?php
2
3$xml = <<<XML
4<?xml version="1.0" encoding="utf-8"?>
5<!DOCTYPE chapter [
6  <!ENTITY entityName "entityValue">
7]>
8<chapter>&entityName;</chapter>
9XML;
10
11$dom = new DOMDocument();
12$dom->loadXML($xml);
13
14$entityRef = $dom->getElementsByTagName('chapter')->item(0)->firstChild;
15
16// DOMEntityReference オブジェクトの nodeName プロパティを取得します。
17// これはエンティティの名前を返します。
18$name = $entityRef->nodeName;
19
20echo $name; // "entityName" を出力します
21
22?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

DOMEntityReferenceノードの名前を表す文字列を返します。

サンプルコード

PHP DOMEntityReferenceのnodeNameを取得する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMEntityReferenceのnodeNameプロパティの使用例を示します。
7 *
8 * この関数は、エンティティ参照を含むXMLを解析し、
9 * エンティティ参照ノードの名前を取得して表示します。
10 */
11function displayEntityReferenceNodeName(): void
12{
13    // DTD(文書型定義)でエンティティ 'author_name' を定義し、
14    // <author>要素内でエンティティ参照 '&author_name;' を使用するXML文字列。
15    $xmlString = <<<XML
16    <?xml version="1.0" encoding="UTF-8"?>
17    <!DOCTYPE book [
18      <!ENTITY author_name "John Doe">
19    ]>
20    <book>
21      <title>PHP DOM Guide</title>
22      <author>&author_name;</author>
23    </book>
24    XML;
25
26    // DOMDocument オブジェクトを作成
27    $dom = new DOMDocument();
28
29    // XMLを読み込む際、エンティティ参照を自動的にテキストに置換しないように設定します。
30    // この設定により、DOMツリー内に DOMEntityReference ノードが作成されます。
31    $dom->substituteEntities = false;
32
33    // XML文字列を読み込みます
34    $dom->loadXML($xmlString);
35
36    // 'author' タグ名を持つ要素を取得します
37    $authorElement = $dom->getElementsByTagName('author')->item(0);
38
39    // 'author' 要素の最初の子ノード（この場合はエンティティ参照ノード）を取得します
40    $entityRefNode = $authorElement->firstChild;
41
42    // ノードが DOMEntityReference のインスタンスであるかを確認します
43    if ($entityRefNode instanceof DOMEntityReference) {
44        // nodeName プロパティは、エンティティ参照の名前 ('author_name') を返します。
45        // タグ名とは異なり、'&' や ';' は含まれません。
46        echo "The nodeName of the entity reference is: " . $entityRefNode->nodeName . PHP_EOL;
47    }
48}
49
50// 関数を実行して結果を表示
51displayEntityReferenceNodeName();
52
53?>

このPHPコードは、XML文書内に定義された「エンティティ参照」の名前を取得する方法を示します。エンティティ参照とは、XML内で特定の文字列を短い名前で定義し、再利用するための仕組みです。

まず、DOMDocumentオブジェクトを作成し、$dom->substituteEntities = false;と設定します。この設定が重要で、XMLを読み込む際に&author_name;のようなエンティティ参照を自動的にその値（この例では "John Doe"）に置き換えず、エンティティ参照そのものを一つのノードとして扱うようにします。

次にloadXMLメソッドでXML文字列を解析し、DOMツリーを構築します。そして、getElementsByTagNameで<author>要素を取得し、その子ノードであるエンティティ参照ノード（DOMEntityReferenceオブジェクト）を変数に格納します。

ここで使用する$entityRefNode->nodeNameプロパティは、このDOMEntityReferenceオブジェクトが持つエンティティ参照の名前を取得します。このプロパティに引数は必要ありません。戻り値として、サンプルコードの&author_name;に対応する名前、つまり'author_name'という文字列が返されます。XML内の記述と異なり、先頭の&や末尾の;は含まれない点に注意が必要です。最終的に、取得した名前をechoで画面に出力しています。

このコードを利用する上で最も重要な注意点は、DOMDocumentオブジェクトのsubstituteEntitiesプロパティをfalseに設定することです。この設定をしないと、エンティティ参照は自動的にテキストに置換されてしまい、DOMEntityReferenceノードとして取得できなくなります。また、nodeNameプロパティが返す値は、&や;を含まないエンティティ名そのものであることを理解しておく必要があります。コードの安全性を高めるために、取得したノードが本当にDOMEntityReference型であるかをinstanceof演算子でチェックすることが推奨されます。この機能は、サンプルコードのようにXML文書内でDTDによりエンティティが定義されている場合に有効です。