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

Copy
1<?php
2
3// DomDocument を使用して XML ドキュメントを作成し、C14N を適用する例
4$dom = new DOMDocument('1.0', 'utf-8');
5$dom->preserveWhiteSpace = false;
6$dom->formatOutput = true;
7
8// ルート要素を作成
9$root = $dom->createElement('root');
10$dom->appendChild($root);
11
12// 子要素を作成
13$child1 = $dom->createElement('child1', 'テキスト1');
14$root->appendChild($child1);
15
16$child2 = $dom->createElement('child2', 'テキスト2');
17$root->appendChild($child2);
18
19// C14N を適用
20$c14n = $dom->C14N();
21
22if ($c14n !== false) {
23    // C14N 適用後の XML を出力
24    echo $c14n . PHP_EOL;
25} else {
26    echo "C14N 適用に失敗しました。" . PHP_EOL;
27}
28
29// XPath を使用して特定のノードのみを C14N に適用する例
30$dom2 = new DOMDocument('1.0', 'utf-8');
31$dom2->preserveWhiteSpace = false;
32$dom2->formatOutput = true;
33
34$root2 = $dom2->createElement('root');
35$dom2->appendChild($root2);
36
37$child3 = $dom2->createElement('child3', 'テキスト3');
38$root2->appendChild($child3);
39
40$child4 = $dom2->createElement('child4', 'テキスト4');
41$root2->appendChild($child4);
42
43$xpath = new DOMXPath($dom2);
44$nodeList = $xpath->query('/root/child3');
45
46$nodes = [];
47foreach ($nodeList as $node) {
48    $nodes[] = $node;
49}
50
51$c14n_exclusive = $dom2->C14N(true, false, $nodes);
52
53if ($c14n_exclusive !== false) {
54    echo $c14n_exclusive . PHP_EOL;
55} else {
56    echo "C14N 適用に失敗しました。" . PHP_EOL;
57}
58?>

PHP 8 の Dom\Document クラスにおける C14N メソッドは、XML ドキュメントを正規化する機能を提供します。XML の構造を標準化することで、異なるシステム間での相互運用性を高めたり、デジタル署名の信頼性を向上させたりすることが可能です。

C14N メソッドは、引数によって正規化の範囲や方法を調整できます。$exclusive は排他的な正規化を行うかどうかを指定するブール値で、true を指定すると、ドキュメント内の名前空間宣言をより厳密に処理します。$withComments は、コメントを含めるかどうかを指定するブール値です。$xpath は、正規化の対象とするノードを XPath 式で指定するための配列です。$nsPrefixes は、正規化に使用する名前空間プレフィックスの配列です。

サンプルコードでは、まず DOMDocument オブジェクトを作成し、XML ドキュメントの構造を定義しています。C14N() を引数なしで呼び出すと、ドキュメント全体が正規化されます。C14N(true, false, $nodes) のように引数を指定すると、XPath で選択された特定のノードのみを排他的に正規化できます。

C14N メソッドは、正規化された XML ドキュメントの文字列を返します。正規化に失敗した場合は false を返します。返り値が false でないことを確認することで、正規化が正常に完了したかどうかを判断できます。

Copy
1<?php
2
3// DomDocument を使用して XML ドキュメントを作成し、C14N 1.1 で正規化する例
4$dom = new DOMDocument('1.0', 'utf-8');
5$dom->preserveWhiteSpace = false;
6$dom->formatOutput = true;
7
8// ルート要素を作成
9$root = $dom->createElement('root');
10$dom->appendChild($root);
11
12// 子要素を追加
13$child1 = $dom->createElement('child1', 'some text');
14$root->appendChild($child1);
15
16$child2 = $dom->createElement('child2');
17$root->appendChild($child2);
18
19$attr = $dom->createAttribute('attribute1');
20$attr->value = 'attr_value';
21$child2->appendChild($attr);
22
23// C14N 1.1 で正規化（排他的、コメントなし）
24$c14n_xml = $dom->C14N(true, false);
25
26if ($c14n_xml === false) {
27    echo "C14N failed\n";
28} else {
29    echo $c14n_xml . "\n";
30}
31
32// C14N 1.1 で正規化（コメントあり、名前空間プレフィックスを指定）
33$dom2 = new DOMDocument('1.0', 'utf-8');
34$dom2->loadXML('<root xmlns:prefix="http://example.org"><child1 prefix:attr="value">text<!-- comment --></child1></root>');
35
36$nsPrefixes = ['prefix'];
37$c14n_xml_with_comments = $dom2->C14N(true, true, null, $nsPrefixes);
38
39if ($c14n_xml_with_comments === false) {
40    echo "C14N with comments failed\n";
41} else {
42    echo $c14n_xml_with_comments . "\n";
43}

PHP 8 の Dom\Document クラスの C14N メソッドは、XML ドキュメントを正規化する機能を提供します。C14N (Canonical XML) とは、XML ドキュメントを標準化された形式に変換するプロセスで、異なるシステム間でのXMLドキュメントの比較やデジタル署名において重要な役割を果たします。

このサンプルコードでは、DOMDocument を使用して XML ドキュメントを作成し、C14N メソッドを使って正規化する方法を示しています。

最初の例では、XML ドキュメントを新規に作成し、要素と属性を追加しています。$dom->C14N(true, false) では、排他的（exclusive = true）かつコメントなし（withComments = false）で正規化を行っています。exclusive が true の場合、ドキュメントノードに直接現れる名前空間ノードのみが出力されます。withComments が false の場合、コメントは出力から除外されます。

2番目の例では、既存の XML ドキュメントをロードし、コメントを含めて正規化しています。$nsPrefixes 配列で名前空間プレフィックスを指定することで、特定の名前空間に関連するノードのみを正規化対象とすることができます。$dom2->C14N(true, true, null, $nsPrefixes) では、排他的（exclusive = true）、コメントあり（withComments = true）、名前空間プレフィックスを指定（nsPrefixes）して正規化しています。

C14N メソッドは、正規化された XML 文字列を返します。エラーが発生した場合は false を返します。このメソッドは、XML データの整合性を保ち、異なる環境間での互換性を高める上で役立ちます。xpath 引数はXPath 式の配列を受け取り、正規化するノードセットを制限できます。