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

Copy
1<?php
2
3/**
4 * Dom\ProcessingInstruction::C14N メソッドの使用例を示します。
5 *
6 * C14N (Canonical XML) は、XML ドキュメントやその一部を標準化された文字列表現に変換します。
7 * これにより、XML の意味的な内容を保ちつつ、物理的な表現の違い（例：空白、属性の順序）を排除し、
8 * 一意のバイト表現を得ることができます。これは特にデジタル署名などで利用されます。
9 *
10 * このサンプルコードでは、XML ドキュメント内の「処理命令」ノードに対して C14N を適用します。
11 */
12function demonstrateDomProcessingInstructionC14N(): void
13{
14    // 1. 新しい DOMDocument オブジェクトを作成します。
15    //    XML のバージョンとエンコーディングを指定します。
16    $doc = new DOMDocument('1.0', 'UTF-8');
17    // 整形出力 (pretty print) は C14N の結果に影響を与えるため、無効にします。
18    $doc->formatOutput = false;
19
20    // 2. XML 処理命令 (Processing Instruction) ノードを作成します。
21    //    処理命令は `<?target data?>` の形式で、XMLパーサに特定の情報を伝えます。
22    //    ここでは 'php' をターゲット (目的のアプリケーション) とし、
23    //    'echo "Hello world";' をデータとして設定します。
24    $target = 'php';
25    $data = 'echo "Hello world from C14N";';
26    $processingInstruction = $doc->createProcessingInstruction($target, $data);
27
28    // 3. 作成した処理命令ノードを DOMDocument に追加します。
29    //    ProcessingInstruction はルートノードとして追加することも可能です。
30    $doc->appendChild($processingInstruction);
31
32    // 4. Dom\ProcessingInstruction オブジェクトの C14N メソッドを呼び出します。
33    //    これにより、処理命令ノードの正規化された文字列表現が取得されます。
34    //    引数を指定しない場合、デフォルト値（非排他的、コメントなし）が適用されます。
35    $canonicalizedOutput = $processingInstruction->C14N();
36
37    // 5. 結果を表示し、エラーがないか確認します。
38    if ($canonicalizedOutput !== false) {
39        echo "--- オリジナル XML ドキュメントの内容 ---" . PHP_EOL;
40        // DOMDocument全体をXML文字列として保存し、表示します。
41        echo $doc->saveXML() . PHP_EOL;
42
43        echo "--- 処理命令の正規化 (C14N) された結果 ---" . PHP_EOL;
44        echo $canonicalizedOutput . PHP_EOL;
45        echo "---------------------------------------" . PHP_EOL;
46
47        // C14N の結果は、ProcessingInstructionノードがもともとシンプルな構造であるため、
48        // この例では元のXML表現とほとんど同一になります。
49        // C14Nの主な利点は、より複雑なXML構造（例：空白、属性の順序、名前空間の宣言）において、
50        // 異なる物理的表現を持つが同じ意味の内容を、一意の文字列に変換できる点にあります。
51
52    } else {
53        echo "エラー: 処理命令の正規化 (C14N) に失敗しました。" . PHP_EOL;
54    }
55}
56
57// 関数を実行してサンプルコードを動作させます。
58demonstrateDomProcessingInstructionC14N();

PHP 8のDom\ProcessingInstruction::C14Nメソッドは、XMLドキュメント内の「処理命令」ノードを、特定のルールに基づいて標準化された文字列形式に変換します。この正規化（Canonical XML）は、XMLの意味的な内容を保ちつつ、空白や属性の順序といった物理的な表現の違いを吸収し、常に一意のバイト表現を得ることを目的としています。これはデジタル署名などでXMLの内容を厳密に比較する際に不可欠な機能です。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、整形出力（formatOutput）をfalseに設定します。次に、createProcessingInstruction()メソッドを使って、ターゲットとデータを指定したXML処理命令ノード（例: <?php echo "Hello...";?>）を作成し、それをドキュメントに追加します。その後、作成したDom\ProcessingInstructionオブジェクトに対してC14N()メソッドを呼び出すことで、この処理命令ノードの正規化された文字列表現が取得されます。

C14N()メソッドは、引数として$exclusive（排他的正規化の有無）、$withComments（コメントを含めるか）、$xpath（正規化対象のノードを限定するXPath）、$nsPrefixes（名前空間プレフィックスの指定）を受け取りますが、これらを省略するとデフォルト値が適用されます。このメソッドは、処理が成功した場合には正規化されたXMLの文字列を返し、失敗した場合にはfalseを返しますので、戻り値を確認して処理の成否を判断することが重要です。

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を返します。