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

Copy
1<?php
2
3/**
4 * XMLドキュメント内の処理命令(Processing Instruction)のターゲットを取得するデモ。
5 *
6 * Dom\ProcessingInstruction クラスの 'target' プロパティの使用例を示します。
7 * 'target' は、処理命令のターゲット名（例: `<?target data?>` の 'target' の部分）を返します。
8 */
9function demonstrateProcessingInstructionTarget(): void
10{
11    // キーワード "php target group s.r.l" に関連付けたXML文字列を定義します。
12    // ターゲットが 'php-target-group'、データが 's.r.l="company"' の処理命令を含みます。
13    $xmlString = <<<XML
14    <?xml version="1.0" encoding="UTF-8"?>
15    <?php-target-group s.r.l="company"?>
16    <root>
17        <element>Some content</element>
18    </root>
19    XML;
20
21    // Dom\Document オブジェクトをインスタンス化します
22    $doc = new \Dom\Document();
23
24    // XML文字列を読み込み、パースします
25    $doc->loadXML($xmlString);
26
27    // ドキュメントの直下の子ノードを順番に確認します
28    foreach ($doc->childNodes as $node) {
29        // ノードが Dom\ProcessingInstruction のインスタンスであるかを確認します
30        if ($node instanceof \Dom\ProcessingInstruction) {
31            // target プロパティにアクセスして、処理命令のターゲット名を取得・表示します
32            echo "Found Processing Instruction." . PHP_EOL;
33            echo "Target: " . $node->target . PHP_EOL; // "php-target-group" が出力されます
34            echo "Data: " . $node->data . PHP_EOL;     // "s.r.l="company"" が出力されます
35            break; // 最初の処理命令を見つけたらループを終了します
36        }
37    }
38}
39
40// 関数を実行します
41demonstrateProcessingInstructionTarget();

このPHPサンプルコードは、XML文書内に含まれる「処理命令（Processing Instruction）」のターゲット名を取得する方法を解説するものです。処理命令とは、XML文書の<?と?>で囲まれた部分のことで、XMLを処理する特定のアプリケーションに対する指示を記述するために使用されます。

このコードでは、Dom\ProcessingInstructionクラスのtargetプロパティを利用します。このプロパティは、処理命令のターゲット部分（例: <?target data?>のtargetの部分）を文字列として取得するためのものです。プロパティへのアクセスに引数は不要で、戻り値としてターゲット名を表す文字列が返されます。

サンプルコードの処理の流れとしては、まず<?php-target-group s.r.l="company"?>という処理命令を含むXMLデータをDom\Documentオブジェクトとして読み込みます。次に、XML文書内の各ノードを調べ、それが処理命令であるかを判定します。処理命令が見つかると、$node->targetのようにtargetプロパティにアクセスし、ターゲット名であるphp-target-groupを取得して画面に出力します。これにより、XML内の特定の命令を識別し、それに応じた処理を実行できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * XML文字列から 'target-price' というターゲットを持つ処理命令(Processing Instruction)を探し、
7 * その情報を表示します。
8 *
9 * Dom\ProcessingInstructionクラスの `target` プロパティを使用して、
10 * 処理命令のターゲット名（例: `<?target-price ...?>` の `target-price` 部分）を取得します。
11 *
12 * @param string $xmlContent 解析対象のXML文字列。
13 */
14function findTargetPriceInstruction(string $xmlContent): void
15{
16    // DOMDocumentオブジェクトを初期化
17    $dom = new \DOMDocument();
18
19    // XML文字列を安全に読み込む
20    if (!$dom->loadXML($xmlContent)) {
21        echo "XMLの解析に失敗しました。";
22        return;
23    }
24
25    // ドキュメントのルート直下にあるノードを走査
26    foreach ($dom->childNodes as $node) {
27        // ノードが処理命令（ProcessingInstruction）であるかを確認
28        if ($node instanceof \Dom\ProcessingInstruction) {
29            // `target` プロパティをチェックして、目的の処理命令か判断
30            if ($node->target === 'target-price') {
31                echo "処理命令ターゲット: " . htmlspecialchars($node->target) . PHP_EOL;
32                echo "目標価格データ: " . htmlspecialchars($node->data) . PHP_EOL;
33            }
34        }
35    }
36}
37
38// サンプルXMLデータ。商品情報の中に目標価格を示す処理命令を含んでいる。
39$productXml = <<<XML
40<?xml version="1.0" encoding="UTF-8"?>
41<product>
42    <id>P-001</id>
43    <name>Professional PHP Development Tool</name>
44    <?target-price currency="JPY" value="15000"?>
45    <price>18000</price>
46</product>
47XML;
48
49// 関数を実行して結果を表示
50findTargetPriceInstruction($productXml);
51
52?>

PHPのDom\ProcessingInstructionクラスは、XML文書内に記述される「処理命令（Processing Instruction）」をオブジェクトとして扱うためのものです。処理命令とは、<?...?>という形式で記述され、特定のアプリケーションに指示を伝える役割があります。

このサンプルコードは、商品情報を表すXMLデータの中から、targetプロパティを利用して「目標価格（target-price）」に関する処理命令を探し出し、その情報を表示する例です。

targetプロパティは、Dom\ProcessingInstructionオブジェクトが持つプロパティで、処理命令の名前部分（ターゲット）を取得するために使用します。このプロパティは引数を取らず、戻り値としてターゲット名が文字列（string）で返されます。例えば<?target-price ...?>という処理命令の場合、targetプロパティの値は文字列'target-price'となります。

コードの流れとしては、まずXML文字列をDOMDocumentオブジェクトに読み込みます。次に、文書内の全ノードを一つずつループで確認し、ノードが処理命令であるかをinstanceofで判定します。処理命令であった場合、$node->target === 'target-price'という条件式でターゲット名が目的のものと一致するかを調べ、一致すればその内容を出力します。このようにtargetプロパティは、特定の処理命令を識別する上で重要な役割を果たします。