【PHP8.x】Dom\ProcessingInstruction::C14N()メソッドの使い方

Copy
1<?php
2
3/**
4 * Dom\ProcessingInstruction::C14N() の使用例を示します。
5 *
6 * XMLドキュメント内の処理命令ノード（例: <?xml-stylesheet ...?>）を
7 * 正規化（Canonicalize）し、その結果を文字列として出力します。
8 */
9function demonstrateXmlProcessingInstructionC14N(): void
10{
11    // 1. 処理命令を含むXML文字列を準備します。
12    // <?xml-stylesheet ...?> が処理命令ノード (Processing Instruction) です。
13    $xmlString = <<<XML
14<?xml version="1.0" encoding="UTF-8"?>
15<?xml-stylesheet type="text/css" href="style.css"?>
16<root>
17    <element>Hello, World!</element>
18</root>
19XML;
20
21    // 2. DOMDocumentオブジェクトを作成し、XMLを読み込みます。
22    $doc = new DOMDocument();
23    $doc->loadXML($xmlString);
24
25    // 3. 処理命令ノードを取得します。
26    //    ドキュメント直下の子ノードを調べ、最初の処理命令ノードを探します。
27    $piNode = null;
28    foreach ($doc->childNodes as $node) {
29        // ノードが Dom\ProcessingInstruction のインスタンスかチェックします。
30        if ($node instanceof Dom\ProcessingInstruction) {
31            $piNode = $node;
32            break;
33        }
34    }
35
36    // 4. 処理命令ノードが見つかった場合に正規化を実行します。
37    if ($piNode) {
38        // C14N()メソッドは、ノードを「正規化」した文字列を返します。
39        // 正規化とは、論理的に等価なXML表現が、物理的（バイト単位）にも
40        // 同一の表現になるように変換する標準的なプロセスです。
41        // XML署名などでデータの完全性を検証する際に重要となります。
42        $canonicalizedOutput = $piNode->C14N();
43
44        if ($canonicalizedOutput !== false) {
45            echo "正規化された処理命令ノード:" . PHP_EOL;
46            // 出力結果: <?xml-stylesheet href="style.css" type="text/css"?>
47            // (属性の順序がアルファベット順に変わることに注意してください)
48            echo $canonicalizedOutput . PHP_EOL;
49        } else {
50            echo "正規化に失敗しました。" . PHP_EOL;
51        }
52    } else {
53        echo "処理命令ノードが見つかりませんでした。" . PHP_EOL;
54    }
55}
56
57// 関数を呼び出してサンプルを実行します。
58demonstrateXmlProcessingInstructionC14N();

Dom\ProcessingInstruction::C14N()メソッドは、XMLドキュメント内の処理命令ノード（例: <?xml-stylesheet ...?>）を、W3Cが定める正規化（Canonicalization）のルールに従って整形し、その結果を文字列として取得するためのものです。正規化とは、論理的に同じ意味を持つXMLデータを、物理的（バイト単位）に完全に同一の表現に変換する標準的なプロセスのことです。これは、XML署名などでデータの完全性を検証する際に非常に重要となります。

サンプルコードでは、まずXML文字列をDOMDocumentオブジェクトとして読み込み、その中から<?xml-stylesheet ...?>で表される処理命令ノードを取得しています。次に、そのノードオブジェクトに対してC14N()メソッドを呼び出します。このメソッドが実行されると、ノードは正規化ルールに基づいて整形されます。コードの実行結果を見ると、元のXMLではtype属性が先でしたが、正規化後は属性名がアルファベット順に並び替えられhrefが先になっていることが確認できます。

このメソッドには、正規化の挙動を細かく制御するための引数がありますが、省略した場合は標準のルールが適用されます。戻り値は、処理が成功した場合は正規化された文字列を、失敗した場合はfalseを返します。