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

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

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

基本的な使い方

nodeNameプロパティは、DOMノードの名前を保持するプロパティです。Dom\Documentクラスに所属し、そのドキュメント内のノードの名前を取得するために使用されます。具体的には、ノードの種類に応じて異なる値を返します。例えば、要素ノードの場合、その要素のタグ名（例：div, p, h1）が返されます。属性ノードの場合は、属性の名前（例：id, class, src）が返されます。テキストノードの場合は、#textという文字列が返されます。ドキュメントノードの場合は、#documentという文字列が返されます。

このプロパティは読み取り専用であり、値を変更することはできません。ノードの名前をプログラム内で参照する必要がある場合に役立ちます。例えば、特定のタグ名を持つ要素を検索したり、属性の名前を検証したりする際に利用できます。DOM (Document Object Model) は、HTMLやXMLドキュメントをプログラムから操作するための標準的なインターフェースであり、nodeNameプロパティはそのDOMツリー構造におけるノードに関する重要な情報を提供します。システムエンジニアがDOMを扱う際、このプロパティを理解しておくことは、ドキュメント構造を解析し、必要な情報を抽出する上で不可欠です。PHPにおけるDOM操作では、このプロパティを通して、要素の種類や特性を判別し、適切な処理を行うことができます。

構文(syntax)


1Dom\Document::$nodeName;

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このプロパティは、ノードの名前を文字列として返します。

サンプルコード

PHP DomDocument::nodeName を取得する


1<?php
2
3/**
4 * Dom\Document::nodeName プロパティの使用例を示す関数です。
5 *
6 * Dom\Document オブジェクトは、XMLまたはHTMLドキュメント全体を表します。
7 * その nodeName プロパティは、ドキュメントノードの名前を返します。
8 * ドキュメントノードの場合、このプロパティは常に "#document" を返します。
9 */
10function demonstrateDomDocumentNodeName(): void
11{
12    // 新しい Dom\Document オブジェクトを作成します。
13    // これは空の新しいXML/HTMLドキュメントを表します。
14    $document = new Dom\Document();
15
16    // Dom\Document オブジェクトの nodeName プロパティにアクセスします。
17    // このプロパティはドキュメントノードの名前を文字列で返します。
18    $nodeName = $document->nodeName;
19
20    // 取得したノード名を表示します。
21    // ドキュメントノードの名前は常に "#document" です。
22    echo "Dom\\Document オブジェクトの nodeName は: " . $nodeName . PHP_EOL;
23}
24
25// 関数を実行して Dom\Document::nodeName の動作を確認します。
26demonstrateDomDocumentNodeName();
27
28?>

PHPのDom\Documentクラスは、XMLやHTMLなどのドキュメント全体をプログラムで操作するためのオブジェクトを表します。このクラスが持つnodeNameプロパティは、ドキュメントの最も上位に位置する「ドキュメントノード」の名前を取得するために使用されます。このプロパティは特別な引数を必要とせず、常にstring型として #document という固定の文字列を戻り値として返します。

提供されたサンプルコードでは、まずnew Dom\Document()を用いて新しいDom\Documentオブジェクトを作成しています。これは、これからXMLやHTMLを扱うための準備として、空のドキュメントがメモリ上に作成された状態を示します。次に、作成された$documentオブジェクトのnodeNameプロパティにアクセスし、その結果を$nodeName変数に格納しています。そして、echo文を使って取得した$nodeNameの値を画面に表示しています。このコードを実行すると、「Dom\Document オブジェクトの nodeName は: #document」と出力され、Dom\DocumentオブジェクトのnodeNameが常に#documentであることを確認できます。これにより、このオブジェクトがドキュメントそのものであることを簡潔に識別できます。

Dom\Document::nodeNameプロパティは、XMLやHTMLドキュメント全体を表すDom\Documentオブジェクトに適用されます。このプロパティはドキュメントノードの名前を返しますが、常に"#document"という固定の文字列を返しますのでご注意ください。これは、HTMLタグなどの要素ノード名（例: <h1>なら"h1"）とは異なり、ドキュメント自体の特別な名前である点を理解しておくことが重要です。このプロパティは読み取り専用であり、値を変更することはできません。PHPのDOM拡張機能が有効な環境で利用できます。