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

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

作成日: 更新日:

基本的な使い方

nodeNameプロパティは、DOMAttrクラスのインスタンスが表す属性の名前を保持するプロパティです。

PHPのDOM拡張モジュールは、XMLやHTMLドキュメントの構造をオブジェクトとして表現し、プログラムから操作するための機能を提供します。このDOMAttrクラスは、ドキュメント内の特定の要素に付随する「属性(attribute)」を表します。例えば、HTMLの<img>タグにあるsrc="image.jpg"という記述において、srcが属性の名前、"image.jpg"がその値に当たります。

nodeNameプロパティは、そのDOMAttrオブジェクトがどの属性の名前を持っているか、具体的に文字列として提供します。例えば、先ほどのsrc属性を表すDOMAttrオブジェクトの場合、nodeNameプロパティは"src"という文字列を返します。

このプロパティは読み取り専用であり、その値を変更することはできません。属性の名前を取得し、その名前に基づいて処理を分岐させたり、ログに出力したりするなど、DOMツリーを走査する際に特定の属性を識別するために利用されます。システムエンジニアとしてDOM操作を学ぶ上で、属性の名前を正確に把握するために非常に基本的ながら重要なプロパティです。

構文(syntax)

1<?php
2$dom = new DOMDocument();
3// 'myAttribute' という名前の DOMAttr オブジェクトを作成します。
4$domAttr = $dom->createAttribute('myAttribute');
5
6// DOMAttr オブジェクトから nodeName プロパティにアクセスし、属性名を取得します。
7$attributeName = $domAttr->nodeName;
8?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

DOMAttrクラスのnodeNameプロパティは、属性の名前を表す文字列を返します。

サンプルコード

PHP DOMDocument nodeNameで属性名を取得する

1<?php
2
3// DOMAttr の nodeName プロパティのサンプルコード
4
5// DOMDocument を作成
6$dom = new DOMDocument();
7
8// 要素を作成
9$element = $dom->createElement('book');
10
11// 属性を作成
12$attribute = $dom->createAttribute('title');
13$attribute->value = 'The Hitchhiker\'s Guide to the Galaxy';
14
15// 要素に属性を追加
16$element->setAttributeNode($attribute);
17
18// DOMAttr ノードを取得
19$attrNode = $element->getAttributeNode('title');
20
21// nodeName プロパティを使用して属性の名前を取得
22$attributeName = $attrNode->nodeName;
23
24// 結果を出力
25echo "属性名: " . $attributeName . PHP_EOL; // 出力: 属性名: title

このサンプルコードは、PHPのDOM拡張モジュールにおけるDOMAttrクラスのnodeNameプロパティの使用例を示しています。DOMAttrは、XMLドキュメントの属性を表すオブジェクトです。nodeNameプロパティは、その属性の名前(文字列)を返します。引数はなく、属性の名前を文字列として取得する際に利用します。

まず、DOMDocumentクラスのインスタンスを作成し、XMLドキュメントを操作するための準備をします。次に、createElementメソッドで'book'という名前の要素を作成し、createAttributeメソッドで'title'という名前の属性を作成します。作成した属性にvalueプロパティで値を設定し、setAttributeNodeメソッドで要素に属性を追加します。

getAttributeNodeメソッドを使って、要素から'title'属性に対応するDOMAttrオブジェクトを取得します。そして、$attrNode->nodeNameと記述することで、DOMAttrオブジェクトが表す属性の名前を取得できます。この例では、$attributeName変数に属性名である'title'が格納されます。最後に、取得した属性名を出力することで、nodeNameプロパティが属性の名前を正しく取得していることを確認できます。このコードは、XMLドキュメントの属性を操作する際の基本的な流れを理解するのに役立ちます。

DOMAttrnodeNameプロパティは、属性の名前を文字列として返します。このサンプルコードでは、title属性の名前を取得しています。nodeNameは読み取り専用であり、値を変更することはできません。属性が存在しない場合にgetAttributeNodenullを返す可能性があるため、$attrNodenullでないことを確認してからnodeNameにアクセスするようにしてください。また、DOMAttrオブジェクトが有効な属性ノードを参照していることを確認することも重要です。無効なノードに対してnodeNameにアクセスすると、予期せぬエラーが発生する可能性があります。

【PHP8.x】nodeNameプロパティの使い方 | いっしー@Webエンジニア