【PHP8.x】nodeNameプロパティの使い方
nodeNameプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
nodeNameプロパティは、PHPのDOM拡張機能におけるDom\Commentクラスのインスタンスが表すノードの名前を保持するプロパティです。
Dom\Commentクラスは、HTMLやXMLといったマークアップ言語のドキュメント内に記述されたコメント(例えば <!-- これはコメントです --> のような形式)をプログラムで扱うためのものです。これらのドキュメントは、要素、テキスト、コメントといった様々な部品(これらを「ノード」と呼びます)で構成されており、それぞれに固有のタイプと名前が割り当てられています。
このnodeNameプロパティは、ドキュメント内の特定のノードがどのような種類であるかを識別するために利用されます。Dom\Commentクラスのインスタンスに対してこのプロパティにアクセスすると、常に固定の文字列である #comment が返されます。これは、W3C(World Wide Web Consortium)によって定められたDOM(Document Object Model)の仕様に基づき、コメントノードであることを示す標準的な識別子です。
したがって、ドキュメントツリーを走査する際に、あるノードがコメントノードであるかどうかをプログラムで判別したい場合に、$node->nodeName === '#comment' のようにこのプロパティの値を比較して利用することができます。このプロパティはコメントの内容そのものを返すものではなく、あくまでノードの種類を示す識別子として機能します。
構文(syntax)
1<?php 2$dom = new DOMDocument(); 3$commentNode = $dom->createComment('これはテストコメントです'); 4 5// Dom\Comment オブジェクトの nodeName プロパティにアクセス 6echo $commentNode->nodeName; 7?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
string
Dom\Comment::nodeName プロパティは、このノードの名称を表す文字列を返します。コメントノードの場合、この値は常に #comment となります。