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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * XML文字列内の処理命令(Processing Instruction)のデータを取得し表示します。
7 *
8 * この関数は、DOMProcessingInstructionオブジェクトの'data'プロパティを使用して、
9 * 処理命令のデータ部分を文字列として抽出する例を示します。
10 */
11function displayProcessingInstructionData(): void
12{
13    // 処理命令 `<?php-style-checker ...?>` を含むXML文字列を定義
14    $xmlString = <<<XML
15    <?xml version="1.0" encoding="UTF-8"?>
16    <?php-style-checker version="1.0" action="off"?>
17    <root>
18      <element>Some content</element>
19    </root>
20    XML;
21
22    // DOMDocumentオブジェクトをインスタンス化
23    $dom = new DOMDocument();
24
25    // XML文字列を読み込む
26    $dom->loadXML($xmlString);
27
28    // ドキュメント内のすべての子ノードを反復処理
29    foreach ($dom->childNodes as $node) {
30        // ノードが処理命令(DOMProcessingInstruction)のインスタンスであるかを確認
31        if ($node instanceof DOMProcessingInstruction) {
32            // DOMProcessingInstructionオブジェクトのプロパティを取得
33            $target = $node->target; // ターゲット名 (例: php-style-checker)
34            $data   = $node->data;   // データ文字列 (例: version="1.0" action="off")
35
36            echo "処理命令が見つかりました:" . PHP_EOL;
37            echo "  - Target: " . htmlspecialchars($target, ENT_QUOTES, 'UTF-8') . PHP_EOL;
38            // 'data' プロパティで処理命令のデータを取得して表示
39            echo "  - Data  : " . htmlspecialchars($data, ENT_QUOTES, 'UTF-8') . PHP_EOL;
40        }
41    }
42}
43
44// 関数を実行
45displayProcessingInstructionData();
46
47?>

このPHPサンプルコードは、XMLドキュメント内に含まれる処理命令（Processing Instruction）から、そのデータ部分を文字列として取得する方法を示しています。DOMProcessingInstructionクラスのdataプロパティは、この処理命令のデータを取得するために使われます。

XMLの処理命令は、<?target data?>という形式で記述され、特定のアプリケーションへの指示を伝えます。dataプロパティは、この処理命令の先頭にあるターゲット名（target）を除いた、後ろに続く文字列全体を取得する役割を持ちます。例えば、<?php-style-checker version="1.0" action="off"?>という処理命令の場合、dataプロパティはversion="1.0" action="off"という文字列を返します。

このプロパティは値を取得するだけなので、引数は必要ありません。戻り値は、処理命令のデータ部分を表す文字列（string型）です。サンプルコードでは、XMLを読み込んだ後、ノードが処理命令であるかを確認し、$node->dataという形でdataプロパティにアクセスして、その内容を画面に出力しています。これにより、XMLに埋め込まれた特定の指示内容をプログラムで扱うことができます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * XML内のPHP処理命令(Processing Instruction)から日時情報を取得して表示するデモクラス
7 */
8class DateProcessor
9{
10    /**
11     * XML文字列を解析し、PHP処理命令を見つけてその内容を実行します。
12     *
13     * このサンプルでは、XML文書内の `<?php ... ?>` という処理命令を扱います。
14     * DOMProcessingInstructionクラスにおいて、
15     * - `target` プロパティは `php` という文字列になります。
16     * - `data` プロパティは `echo '現在の日時: ' . date('Y-m-d H:i:s');` という文字列になります。
17     *
18     * ここでは `data` プロパティの値（PHPコード）を取得し、実行することで現在日時を表示します。
19     *
20     * @return void
21     */
22    public function displayDateFromXml(): void
23    {
24        // PHPの処理命令を含むXML文字列を定義
25        $xmlString = <<<XML
26        <?xml version="1.0" encoding="UTF-8"?>
27        <report>
28          <title>日次レポート</title>
29          <timestamp>
30            <?php echo '生成日時: ' . date('Y年m月d日 H時i分s秒'); ?>
31          </timestamp>
32        </report>
33        XML;
34
35        // DOMDocumentオブジェクトを生成
36        $dom = new DOMDocument();
37        // XML文字列を読み込む
38        $dom->loadXML($xmlString);
39
40        // すべてのノードをループして処理命令を探す
41        foreach ($dom->childNodes as $node) {
42            // ノードがDOMProcessingInstructionのインスタンスかチェック
43            if ($node instanceof DOMProcessingInstruction) {
44                // 処理命令のターゲットが'php'であるかチェック
45                if ($node->target === 'php') {
46                    // DOMProcessingInstruction->data プロパティからPHPコードを取得
47                    $phpCode = $node->data;
48
49                    echo "XMLから抽出した処理命令のデータ部:\n";
50                    echo "「" . htmlspecialchars(trim($phpCode), ENT_QUOTES, 'UTF-8') . "」\n\n";
51
52                    echo "上記データをPHPコードとして実行した結果:\n";
53                    // 取得したコードを実行
54                    // 注意: eval()は任意のコードを実行できるため、信頼できない入力に使用することは非常に危険です。
55                    // このサンプルは、dataプロパティの動作を説明するためにのみ使用しています。
56                    eval($phpCode);
57                    echo "\n";
58                }
59            }
60        }
61    }
62}
63
64// クラスのインスタンスを作成し、メソッドを実行
65$processor = new DateProcessor();
66$processor->displayDateFromXml();

このサンプルコードは、XML文書内に埋め込まれたPHPの処理命令（Processing Instruction）を解析し、その内容を取得して実行する例です。XML内の<?php ... ?>という記述は、PHPのDOM拡張機能においてDOMProcessingInstructionオブジェクトとして扱われます。

DOMProcessingInstructionクラスのdataプロパティは、この処理命令の内容部分、つまり<?phpと?>に挟まれたコードを文字列として取得するために使用します。このプロパティに引数はなく、戻り値として処理命令の内容である文字列(string)を返します。サンプルコードでは、$node->dataによってecho '生成日時: ' . date('Y年m月d日 H時i分s秒');というPHPコードが文字列として変数に代入されます。

キーワードであるphpは処理命令の対象を示すtargetプロパティの値として現れ、date()関数はdataプロパティで取得したコード文字列の中で、現在日時を整形するために利用されています。最終的に、取得したコード文字列をeval()関数で実行することで、XML内に記述された通りに日時が出力されます。このようにdataプロパティは、処理命令の具体的な内容を取り出すための重要な役割を担います。