【PHP8.x】DOMText::localNameプロパティの使い方

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

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

基本的な使い方

localNameプロパティは、DOMTextオブジェクトのローカル名を保持するプロパティです。

DOMTextクラスは、HTMLやXMLドキュメント内のテキストデータ、つまり文字情報のみを含むノード（テキストノード）を表すために利用されます。例えば、HTMLの段落タグ<p>ここにテキスト</p>の中にある「ここにテキスト」という部分がテキストノードに該当します。

一般的に、DOM（Document Object Model）におけるローカル名とは、要素ノードや属性ノードなどのタグ名や属性名から、名前空間のプレフィックスを除いた部分を指します。例えば、<my:element>という要素の場合、「element」がローカル名です。

しかし、DOMTextが表すテキストノードは、要素ノードとは異なり、タグを持たず、名前空間の概念も適用されません。このため、DOMTextオブジェクトに対してlocalNameプロパティを参照すると、常にnullが返されます。これは、テキストノードが純粋な文字列データであり、要素のように名前空間を識別する必要がある構造ではないことに起因します。

システムエンジニアを目指す方にとって、DOMツリーを操作する際には、ノードのタイプによって各プロパティの挙動が異なることを理解しておくことが重要です。localNameプロパティは、DOMElementのような要素ノードでは有効な文字列を返しますが、DOMTextノードでは常にnullを返すという特性を覚えておきましょう。この知識は、DOMツリーを正確に走査し、ノードの種類に応じて適切な処理を行うための堅牢なコードを記述する上で役立ちます。

構文(syntax)


1<?php
2$document = new DOMDocument();
3$textNode = $document->createTextNode('これはテキストノードです');
4
5var_dump($textNode->localName);
6?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

?string

DOMTextノードのローカル名を表す文字列、または名前空間を持たない場合はNULLを返します。

サンプルコード

DOMText localName は NULL になる


1<?php
2
3/**
4 * DOMText::localName プロパティの使用例を示します。
5 * DOMText ノードの localName は通常 null になることを、DOMElement ノードと比較して説明します。
6 * システムエンジニアを目指す初心者にも理解しやすいように簡潔に記述しています。
7 */
8function demonstrateDomTextLocalName(): void
9{
10    // 1. XML文字列をDOMドキュメントにロードします。
11    // ここでは、テキストノードと要素ノードの両方を含む簡単なXMLを使用します。
12    // <item>タグの内側にテキスト ("Hello ") と <name>要素 (<name>World</name>) があります。
13    $dom = new DOMDocument();
14    $dom->loadXML('<root><item>Hello <name>World</name>!</item></root>');
15
16    // 2. テキストノードと要素ノードのインスタンスを取得します。
17    // DOMDocument のメソッドを使って、対象のノードを見つけます。
18
19    // ルート要素 <root> を取得します。
20    $root = $dom->documentElement;
21
22    // <item> 要素を取得します。
23    $itemElement = $root->getElementsByTagName('item')->item(0);
24
25    // <item> 要素の子ノードを走査し、最初のテキストノードを見つけます。
26    // <item>の子は「Hello 」(DOMText)、「<name>」(DOMElement)、「!」(DOMText)です。
27    $textNode = null;
28    foreach ($itemElement->childNodes as $child) {
29        if ($child instanceof DOMText) {
30            $textNode = $child; // 最初のテキストノード "Hello " を取得
31            break;
32        }
33    }
34
35    // <name> 要素を取得します。
36    $nameElement = $itemElement->getElementsByTagName('name')->item(0);
37
38
39    // 3. DOMText インスタンスの localName プロパティにアクセスし、結果を表示します。
40    echo "--- DOMText ノードの localName ---\n";
41    if ($textNode) {
42        echo "ノード値 (DOMText): '" . $textNode->nodeValue . "'\n";
43        echo "localName: " . var_export($textNode->localName, true) . "\n";
44        echo "補足: テキストノードは要素ではないため、XML名前空間上のローカル名を持たず、通常は NULL となります。\n\n";
45    } else {
46        echo "警告: テキストノードが見つかりませんでした。\n\n";
47    }
48
49
50    // 4. DOMElement インスタンスの localName プロパティにアクセスし、結果を表示します (比較のため)。
51    echo "--- DOMElement ノードの localName (比較) ---\n";
52    if ($nameElement) {
53        echo "ノード名 (DOMElement): '" . $nameElement->nodeName . "'\n";
54        echo "localName: " . var_export($nameElement->localName, true) . "\n";
55        echo "補足: 要素ノードの場合、localName はその要素の名前 (タグ名) を返します。\n";
56    } else {
57        echo "警告: 要素ノードが見つかりませんでした。\n";
58    }
59}
60
61// 上記で定義した関数を実行して、サンプルコードの動作を確認します。
62demonstrateDomTextLocalName();

PHPのDOMText::localNameプロパティは、XMLドキュメント内のテキストノードが持つローカル名を取得するために使用されます。引数はなく、戻り値は文字列（string）またはnull（?string）です。このプロパティは、特にXML名前空間が使用される場合に意味を持ちますが、DOMTextノードは要素ではないため、通常は名前空間上のローカル名を持たず、その結果としてnullを返します。

このサンプルコードでは、まず簡単なXML文字列をDOMドキュメントに読み込みます。次に、そのドキュメントからテキストノードと要素ノードをそれぞれ取得します。取得したDOMTextインスタンスのlocalNameプロパティにアクセスすると、その値はnullとなることを確認できます。これは、テキストノードがXML要素のように名前空間に属する名前を持たないためです。

対照的に、比較のためにDOMElementインスタンス（この例では<name>要素）のlocalNameプロパティにアクセスすると、その要素の名前、すなわち「name」という文字列が返されます。これにより、localNameプロパティがノードの種類（テキストノードか要素ノードか）によって異なる挙動を示すことを明確に理解できます。XMLを扱う際、ノードの種類に応じたプロパティの挙動を把握することは重要です。

DOMText::localNameプロパティは、テキストノードがXML名前空間におけるローカル名を持たないため、通常はnullを返します。この点は、要素ノード（DOMElement）のlocalNameが要素名（タグ名）を返すのと大きく異なりますので、混同しないよう注意が必要です。テキストノードの実際の内容を取得したい場合はnodeValueプロパティを使用してください。localNameの戻り値は?string型であり、nullが返ってくる可能性があるため、常にnullチェックを行い、安全に処理を進めることをお勧めします。DOM操作では、目的のノードがDOMTextインスタンスなのかDOMElementインスタンスなのかを正確に把握し、それぞれのプロパティの特性を理解して利用することが大切です。

PHP DOMText localName を確認する


1<?php
2
3/**
4 * DOMText::localName プロパティの使用例を示します。
5 * DOMTextノードは要素ではないため、localNameプロパティは常にnullを返します。
6 * このコードは、PHPが動作するローカルサーバー環境（例: Apache, Nginx, またはPHP組み込みウェブサーバー）
7 * で直接実行して、HTMLドキュメントのテキストノード情報を確認することを想定しています。
8 */
9function demonstrateDomTextLocalName(): void
10{
11    // 新しいDOMDocumentインスタンスを作成
12    $dom = new DOMDocument();
13
14    // HTML文字列をロード
15    // 構造をシンプルにするため、最小限のHTMLを使用
16    // loadHTML()は、不正なHTMLに対しても寛容ですが、内部エラーを発生させることがあります。
17    // その場合、libxml_use_internal_errors(true) で抑制できますが、今回はシンプルさを優先します。
18    $htmlContent = '<!DOCTYPE html><html><body><h1>タイトル</h1><p>これはテストです。</p>テキストノードもあります。</body></html>';
19    $dom->loadHTML($htmlContent);
20
21    // DOMXpathを使用して、すべてのテキストノードを検索します。
22    $xpath = new DOMXPath($dom);
23    $textNodes = $xpath->query('//text()');
24
25    echo "DOMTextノードのlocalNameプロパティを確認します。\n";
26    echo "----------------------------------------\n";
27
28    if ($textNodes->length === 0) {
29        echo "ドキュメント内にテキストノードが見つかりませんでした。\n";
30        return;
31    }
32
33    foreach ($textNodes as $textNode) {
34        // $textNodeがDOMTextのインスタンスであることを確認します。
35        // DOMXPath::query('//text()')はDOMTextオブジェクトを返します。
36        if ($textNode instanceof DOMText) {
37            // テキストノードの値から余分な空白を削除し、空のノードはスキップします。
38            $nodeValue = trim($textNode->nodeValue);
39            if ($nodeValue === '') {
40                continue;
41            }
42
43            echo "ノード値: \"" . htmlspecialchars($nodeValue) . "\"\n";
44            // DOMTextノードのlocalNameは常にnullです。
45            echo "  localName: " . var_export($textNode->localName, true) . "\n";
46            // DOMTextノードのnodeNameは常に'#text'です。
47            echo "  nodeName: " . htmlspecialchars($textNode->nodeName) . "\n";
48            // DOMTextノードのnodeTypeはDOM_TEXT (定数3) です。
49            echo "  nodeType: " . $textNode->nodeType . " (DOM_TEXT)\n";
50            echo "----------------------------------------\n";
51        }
52    }
53}
54
55// 関数を実行して、結果を出力します。
56demonstrateDomTextLocalName();
57
58?>

PHPのDOMText::localNameプロパティは、HTMLやXMLドキュメントの構造を扱うDOM拡張機能の一部です。これは、ドキュメント内のテキストノードに焦点を当てたプロパティです。テキストノードとは、HTMLタグのような要素ではなく、純粋なテキスト部分（例: <p>ここにテキスト</p>の「ここにテキスト」の部分）を指します。

DOMText::localNameプロパティは、要素のローカル名を取得するために設計されていますが、DOMTextクラスのインスタンスは要素そのものではないため、このプロパティは常にnullを返します。引数はなく、戻り値の型は?stringとなっており、これは文字列またはnullが返されることを示していますが、DOMTextの場合は常にnullとなります。

サンプルコードでは、DOMDocumentを使ってHTML文字列を解析し、DOMXPathでドキュメント内のすべてのテキストノードを検索しています。そして、見つかった各テキストノードに対してlocalNameプロパティの値を出力していますが、結果は常にnullとなります。同時に、テキストノードのnodeNameが#textであり、nodeTypeがDOM_TEXT（定数3）であることも確認できます。このコードは、PHPが動作するローカルサーバー環境（例えばApache、Nginx、またはPHPの組み込みウェブサーバー）で実行し、HTMLドキュメントのテキストノード情報を具体的に確認することができます。

DOMTextノードのlocalNameプロパティは常にnullを返します。localNameはHTMLやXMLの要素（DOMElement）に適用される概念で、テキストノード（DOMText）は要素ではないからです。テキスト内容をnodeValue、ノード名をnodeName（常に#text）で確認します。PHPローカルサーバーで実行し、ブラウザで確認してください。空白ノードのtrim()による除外や、htmlspecialchars()での安全な出力は、実用上の重要な注意点です。