【PHP8.x】C14Nメソッドの使い方

Copy
1<?php
2
3// XML ドキュメントを正規化 (Canonicalization) するサンプルコード
4// C14N (Canonical XML) は、XML ドキュメントを標準化された形式に変換するプロセスです。
5
6// 新しい DOMDocument オブジェクトを作成します。
7$dom = new DOMDocument('1.0', 'utf-8');
8
9// ルート要素を作成します。
10$root = $dom->createElement('root');
11$dom->appendChild($root);
12
13// 子要素を作成します。
14$child1 = $dom->createElement('child1', 'value1');
15$root->appendChild($child1);
16
17$child2 = $dom->createElement('child2', 'value2');
18$root->appendChild($child2);
19
20// C14N を実行し、正規化された XML 文字列を取得します。
21// $exclusive = true  排他的C14Nを有効にします。これにより、ドキュメントのサブツリーのみが正規化されます。
22// $with_comments = true コメントを含めます。
23// $xpath  特定のノードセットのみを正規化するために使用できるXPath式の配列。
24// $ns_prefixes  正規化された出力に含める名前空間プレフィックスの配列。
25$canonicalXml = $dom->C14N(false, false, null, null);
26
27// 正規化された XML を出力します。
28if ($canonicalXml !== false) {
29    echo $canonicalXml . PHP_EOL;
30} else {
31    echo "C14N failed." . PHP_EOL;
32}
33
34?>

このPHPサンプルコードは、XMLドキュメントを正規化（Canonicalization）するDOMDocument::C14Nメソッドの利用例を示しています。C14Nは、XMLドキュメントを標準化された形式に変換する処理であり、異なるシステム間でのXMLデータの比較や署名などに役立ちます。

まず、DOMDocumentオブジェクトを新規に作成し、XMLドキュメントの構造を構築します。ここでは、ルート要素rootと、その子要素child1、child2を作成し、それぞれの要素に値を設定しています。

DOMDocument::C14Nメソッドは、XMLドキュメントを正規化し、その結果を文字列として返します。引数には、正規化のオプションを指定できます。

• $exclusive: 排他的C14Nを有効にするかどうか（デフォルトはfalse）。trueにすると、ドキュメントのサブツリーのみが正規化されます。
• $with_comments: コメントを正規化された出力に含めるかどうか（デフォルトはfalse）。
• $xpath: 正規化するノードセットをXPath式で指定する配列（デフォルトはnull）。
• $ns_prefixes: 正規化された出力に含める名前空間プレフィックスの配列（デフォルトはnull）。

サンプルコードでは、これらの引数をすべてデフォルト値（false, false, null, null）で使用しています。

DOMDocument::C14Nメソッドは、正規化に成功した場合に正規化されたXML文字列を返し、失敗した場合はfalseを返します。サンプルコードでは、戻り値がfalseでないことを確認し、正規化されたXML文字列を出力しています。

Copy
1<?php
2
3// XMLドキュメントをC14N 1.1形式で正規化する例
4function canonicalizeXML(string $xmlString, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false
5{
6    $dom = new DOMDocument();
7    $dom->loadXML($xmlString);
8
9    // C14N 1.1形式で正規化
10    $canonicalXml = $dom->C14N($exclusive, $withComments, $xpath, $nsPrefixes);
11
12    return $canonicalXml;
13}
14
15// サンプルXMLデータ
16$xml = <<<XML
17<root>
18  <element attribute="value">
19    <!-- コメント -->
20    テキスト
21  </element>
22</root>
23XML;
24
25// C14N 1.1形式で正規化（コメントを含む）
26$canonicalizedXml = canonicalizeXML($xml, false, true);
27
28if ($canonicalizedXml !== false) {
29    echo $canonicalizedXml . "\n";
30} else {
31    echo "正規化に失敗しました。\n";
32}
33
34?>

このサンプルコードは、PHPのDOMDocumentクラスのC14Nメソッドを使用して、XMLドキュメントをC14N 1.1形式で正規化する方法を示しています。C14N（Canonical XML）とは、XMLドキュメントを標準化された形式に変換するプロセスのことで、デジタル署名やデータ比較において重要です。

canonicalizeXML関数は、XML文字列を受け取り、DOMDocumentオブジェクトを作成してXMLをロードします。そして、C14Nメソッドを呼び出してXMLを正規化します。

C14Nメソッドの引数は以下の通りです。

• $exclusive: 排他的正規化を行うかどうかを指定するブール値。デフォルトはfalseです。
• $withComments: コメントを含めるかどうかを指定するブール値。trueの場合、コメントも正規化されます。デフォルトはfalseです。
• $xpath: 正規化の対象とするノードをXPath式で指定する配列。nullの場合、ドキュメント全体が対象となります。
• $nsPrefixes: 名前空間プレフィックスを制限する配列。nullの場合、すべての名前空間プレフィックスが使用されます。

C14Nメソッドは、正規化されたXML文字列を返します。エラーが発生した場合はfalseを返します。

サンプルコードでは、コメントを含むXMLをC14N 1.1形式で正規化し、結果を出力しています。正規化に失敗した場合は、エラーメッセージが表示されます。この例では$withCommentsにtrueを渡すことで、XMLに含まれるコメントも正規化後のXMLに含まれるようになります。