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

localNameプロパティは、処理命令（Processing Instruction）のターゲット名を保持するプロパティです。処理命令とは、XML文書内で特定のアプリケーションに対して特別な指示を与えるための構文です。例えば、<?xml-stylesheet ...?>という記述が処理命令にあたり、この場合のターゲットはxml-stylesheetとなります。このプロパティにアクセスすると、この例ではxml-stylesheetという文字列が返されます。DOMProcessingInstructionオブジェクトにおいて、localNameプロパティが返す値は、同じく処理命令のターゲット名を表すtargetプロパティが返す値と常に同じになります。これは、DOMProcessingInstructionクラスがDOMNodeクラスを継承しており、その仕様に基づいているためです。なお、このプロパティは読み取り専用であり、localNameプロパティを通じてターゲット名を変更することはできません。XML文書を解析し、特定の処理命令を識別してそのターゲット名を取得したい場合にこのプロパティを使用します。

Copy
1<?php
2
3$xml_string = <<<XML
4<?xml version="1.0" encoding="UTF-8"?>
5<?php-app target="controller" action="index"?>
6<root/>
7XML;
8
9$doc = new DOMDocument();
10$doc->loadXML($xml_string);
11
12// DOMProcessingInstruction ノードを取得
13$pi_node = $doc->childNodes[1];
14
15// DOMProcessingInstruction の localName プロパティ (読み取り専用)
16// 処理命令のターゲット名を取得します
17$local_name = $pi_node->localName;
18
19// string(8) "php-app"
20var_dump($local_name);
21
22?>

引数なし

引数はありません

string|null

DOMProcessingInstruction クラスの localName プロパティは、処理命令の名前を表す文字列、または名前が取得できない場合は null を返します。