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

Copy
1<?php
2
3/**
4 * DOMDocumentとDOMElement::nodeNameプロパティの使用例を示します。
5 *
6 * この関数は、XML文字列をDOMDocumentにロードし、特定の要素を取得し、
7 * そのDOMElementのnodeNameプロパティにアクセスして表示します。
8 * nodeNameプロパティは、要素のタグ名（ノード名）を文字列で返します。
9 */
10function demonstrateDomElementNodeName(): void
11{
12    // 新しい DOMDocument オブジェクトを作成します。
13    // '1.0'はXMLバージョン、'UTF-8'はエンコーディングを指定します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15
16    // 整形された出力のために設定します (任意ですが、デバッグ時に役立ちます)。
17    $dom->formatOutput = true;
18
19    // 解析するXML文字列を定義します。
20    $xmlString = '<bookstore><book category="web"><title lang="ja">PHP入門</title><author>名無しの開発者</author></book></bookstore>';
21
22    // XML文字列をDOMDocumentにロードします。
23    // 成功した場合true、失敗した場合falseを返します。
24    if (!$dom->loadXML($xmlString)) {
25        echo "XML文字列のロードに失敗しました。" . PHP_EOL;
26        return;
27    }
28
29    // ドキュメント内のすべての 'title' タグを持つ要素を取得します。
30    // これは DOMNodeList オブジェクトを返します。
31    $titles = $dom->getElementsByTagName('title');
32
33    // 'title' 要素が一つ以上存在するか確認します。
34    if ($titles->length > 0) {
35        // DOMNodeList から最初の 'title' 要素 (DOMElement) を取得します。
36        // item(0) はリストの最初の要素を指します。
37        $firstTitleElement = $titles->item(0);
38
39        // 取得した DOMElement の nodeName プロパティにアクセスします。
40        // nodeName は要素のタグ名（この場合 'title'）を文字列として返します。
41        $nodeName = $firstTitleElement->nodeName;
42
43        echo "取得した要素のノード名 (nodeName): " . $nodeName . PHP_EOL; // 出力: 取得した要素のノード名 (nodeName): title
44    } else {
45        echo "指定された 'title' 要素が見つかりませんでした。" . PHP_EOL;
46    }
47}
48
49// 関数を実行して、DOMElement::nodeName の動作を確認します。
50demonstrateDomElementNodeName();
51
52?>

PHPのDOMElement::nodeNameプロパティは、XMLやHTMLドキュメント内で操作している特定の要素のタグ名を取得するために使用されます。このプロパティは、所属するDOMElementオブジェクトが表す要素のタグ名を文字列として提供します。例えば、<title>要素であれば「title」、<book>要素であれば「book」といった形で、そのタグ名がそのまま文字列として得られます。

サンプルコードでは、まずDOMDocumentクラスを用いてXML文字列を読み込み、DOMツリーを構築しています。次に、getElementsByTagName('title')メソッドを使って、ドキュメント内のすべてのtitleタグを持つ要素を検索し、その中から最初のtitle要素を取得しています。取得したDOMElementオブジェクトに対して、$firstTitleElement->nodeNameとアクセスすることで、この要素のタグ名「title」を簡単に取得し、画面に表示しています。

nodeNameプロパティは引数を一切取らず、要素のタグ名をstring型の戻り値として直接返します。これにより、プログラムがドキュメントを解析する際に、各要素がどのような種類のものであるかを識別し、それに応じた処理を行うことが可能になります。このプロパティは、XMLやHTMLの内容を動的に操作・検証するシステム開発において、非常に役立つ基本的な機能です。