【PHP8.x】Dom\ProcessingInstruction::dataプロパティの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * XMLドキュメント内の処理命令(Processing Instruction)からデータを取得して表示します。
7 *
8 * Dom\ProcessingInstruction オブジェクトは、XMLドキュメント内の `<?...?>` タグを表現します。
9 * このオブジェクトの `data` プロパティは、ターゲット名を除いた残りのコンテンツ文字列を返します。
10 */
11function demonstrateProcessingInstructionData(): void
12{
13    // 処理命令 (<?xml-stylesheet ...?>) を含むXML文字列を定義
14    $xmlString = <<<XML
15    <?xml version="1.0" encoding="UTF-8"?>
16    <?xml-stylesheet type="text/css" href="style.css"?>
17    <document>
18      <title>Sample Document</title>
19    </document>
20    XML;
21
22    // DOMDocument オブジェクトをインスタンス化
23    $doc = new \Dom\Document();
24
25    // XML文字列を読み込んでDOMツリーを構築
26    $doc->loadXML($xmlString);
27
28    // ドキュメントの直下の子ノードを順に確認
29    foreach ($doc->childNodes as $node) {
30        // ノードが Dom\ProcessingInstruction のインスタンスであるかを確認
31        if ($node instanceof \Dom\ProcessingInstruction) {
32            // 処理命令のターゲット名（例: 'xml-stylesheet'）
33            $target = $node->target;
34
35            // `data` プロパティにアクセスし、処理命令のデータを取得
36            // （例: 'type="text/css" href="style.css"'）
37            $data = $node->data;
38
39            // 取得したターゲット名とデータを表示
40            echo "Processing Instruction Found:" . PHP_EOL;
41            echo "  - Target: " . $target . PHP_EOL;
42            echo "  - Data  : " . $data . PHP_EOL;
43            break; // 最初の処理命令を見つけたらループを終了
44        }
45    }
46}
47
48// 関数を実行
49demonstrateProcessingInstructionData();
50

PHPのDom\ProcessingInstructionクラスに属するdataプロパティは、XML文書内の処理命令（Processing Instruction）が持つデータ部分を文字列として取得するために使用されます。処理命令は<?ターゲット データ?>という形式で記述され、XMLを処理するアプリケーションへの指示を含んでいます。

このdataプロパティにアクセスすると、処理命令の中から「ターゲット」と呼ばれる最初のキーワードを除いた、残りの内容すべてが戻り値として返されます。値を取得するプロパティのため、引数は必要ありません。

サンプルコードでは、<?xml-stylesheet type="text/css" href="style.css"?>という処理命令を含むXML文字列を解析しています。プログラムはXML文書内のノードを順番に確認し、処理命令を表すDom\ProcessingInstructionオブジェクトを見つけます。そして、そのオブジェクトのdataプロパティを参照することで、ターゲット名であるxml-stylesheetを除いたtype="text/css" href="style.css"という文字列を取得し、画面に出力します。このようにdataプロパティは、処理命令の具体的な指示内容を簡単に取り出すための機能です。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * XML内のPHP処理命令から日付関連のデータを取得するサンプル.
7 *
8 * この関数は、XML文字列をパースし、その中に含まれる
9 * PHPの処理命令 (Processing Instruction) を見つけ出します。
10 * そして、`Dom\ProcessingInstruction` オブジェクトの `data` プロパティを使い、
11 * 処理命令のデータ部分（この例ではPHPの `date()` 関数呼び出しコード）を取得して表示します。
12 */
13function getPhpDateInstructionData(): void
14{
15    // `date()`関数を含むPHP処理命令が埋め込まれたXML文字列
16    $xmlString = <<<XML
17    <?xml version="1.0" encoding="UTF-8"?>
18    <report>
19      <timestamp>
20        <?php echo date(DATE_ATOM); ?>
21      </timestamp>
22      <message>This is a sample report.</message>
23    </report>
24    XML;
25
26    // DOMDocumentオブジェクトをインスタンス化し、XMLを読み込む
27    $dom = new \DOMDocument();
28    $dom->loadXML($xmlString);
29
30    // XPathを使用して、ターゲットが 'php' の処理命令ノードを検索する
31    $xpath = new \DOMXPath($dom);
32    /** @var \DOMNodeList<\DOMProcessingInstruction> $instructions */
33    $instructions = $xpath->query('//processing-instruction("php")');
34
35    // 見つかった最初の処理命令ノードを取得
36    $instructionNode = $instructions->item(0);
37
38    if ($instructionNode instanceof \DOMProcessingInstruction) {
39        // `target` プロパティは、処理命令のターゲット名（例: 'php'）を返す
40        echo 'ターゲット: ' . $instructionNode->target . PHP_EOL;
41
42        // `data` プロパティは、処理命令のデータ部分を文字列で返す
43        // この場合、' echo date(DATE_ATOM); ' が取得される
44        echo 'データ: ' . $instructionNode->data . PHP_EOL;
45    } else {
46        echo 'PHPの処理命令が見つかりませんでした。' . PHP_EOL;
47    }
48}
49
50// 関数を実行して結果を表示
51getPhpDateInstructionData();

このPHPサンプルコードは、XML文書内に含まれる「処理命令（Processing Instruction）」から、その内容を取得する方法を示しています。XMLの処理命令とは、サンプルコード内の <?php ... ?> のように、特定のアプリケーションに対する指示を記述する部分のことです。

コードではまず、DOMDocumentクラスを使ってXML文字列を解析し、DOMオブジェクトに変換します。次に、DOMXPathを用いて、ターゲットが php と指定された処理命令ノードを検索します。

検索によって取得された Dom\ProcessingInstruction オブジェクトの data プロパティは、処理命令の具体的な内容を文字列として取得する役割を持ちます。このプロパティに引数はなく、戻り値として処理命令の内容が文字列 (string) 型で返されます。サンプル内の <?php echo date(DATE_ATOM); ?> という処理命令に対して data プロパティを使用すると、ターゲット名である php を除いた、echo date(DATE_ATOM); という文字列が取得できます。

このように data プロパティを利用することで、XMLに埋め込まれた特定のプログラム向けの指示やデータを、PHPスクリプトで簡単に取り出して利用することが可能になります。