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

Copy
1<?php
2
3/**
4 * DOMNode::C14N() のサンプルコード
5 *
6 * XML ドキュメントのノードを正規化 (Canonicalization) して文字列として取得します。
7 */
8
9// テスト用のXMLドキュメントを作成
10$xmlString = <<<XML
11<root>
12  <child attr1="value1" attr2="value2">
13    <!-- コメント -->
14    テキストノード
15  </child>
16</root>
17XML;
18
19// DOMDocumentをロード
20$dom = new DOMDocument();
21$dom->loadXML($xmlString);
22
23// 正規化したいノードを選択 (ここではルートノード)
24$node = $dom->documentElement;
25
26// C14Nを実行
27$canonicalXML = $node->C14N(
28    exclusive: false, // 排他的な正規化を行うかどうか
29    with_comments: true, // コメントを含めるかどうか
30    xpath: null, // XPath式で選択されたノードのみを正規化するかどうか
31    ns_prefixes: null // 名前空間プレフィックスの配列
32);
33
34// 結果を出力
35if ($canonicalXML !== false) {
36    echo $canonicalXML . PHP_EOL;
37} else {
38    echo "C14N failed." . PHP_EOL;
39}

このサンプルコードは、PHPのDOMNodeクラスにおけるC14Nメソッドの使い方を示しています。C14Nメソッドは、XMLドキュメント内のノードを正規化（Canonicalization）し、その結果を文字列として取得するために使用します。正規化とは、XMLドキュメントの内容を特定の規則に従って標準化する処理のことです。

まず、テスト用のXMLドキュメントを文字列として定義し、それをDOMDocumentオブジェクトにロードしています。次に、正規化したいノードを選択します。この例では、ルートノード（documentElement）を選択しています。

C14Nメソッドは、以下の引数を受け取ります。exclusive は排他的な正規化を行うかどうかを指定するブール値です。with_comments はコメントを含めるかどうかを指定するブール値です。xpath はXPath式で選択されたノードのみを正規化する場合に使用する配列です。ns_prefixes は名前空間プレフィックスの配列を指定します。これらの引数は省略可能で、デフォルト値が設定されています。

サンプルコードでは、exclusive を false（排他的な正規化を行わない）、with_comments を true（コメントを含める）、xpath と ns_prefixes を null（すべてのノードを正規化し、名前空間プレフィックスは指定しない）に設定しています。

C14Nメソッドの戻り値は、正規化されたXML文字列です。処理が失敗した場合は false が返されます。サンプルコードでは、戻り値が false でないことを確認し、正規化されたXML文字列を出力しています。もし false が返された場合は、エラーメッセージが表示されます。

Copy
1<?php
2
3// DOMDocument を作成し、XML をロードする
4$dom = new DOMDocument();
5$dom->loadXML('<root><child attr="value">text</child></root>');
6
7// ルートノードを取得
8$root = $dom->documentElement;
9
10// C14N (Canonical XML) を実行し、結果を出力する
11// exclusive, with_comments, xpath, ns_prefixes の引数は省略可能
12$canonicalXml = $root->C14N(exclusive: true, with_comments: false);
13
14if ($canonicalXml !== false) {
15    echo $canonicalXml;
16} else {
17    echo "C14N failed.";
18}
19
20?>

このPHPのサンプルコードは、DOMNodeクラスのC14Nメソッドを使用して、XMLドキュメントのノードを標準化された形式（Canonical XML）に変換する方法を示しています。C14Nメソッドは、XMLの構造や属性の順序などを一定のルールに従って変換することで、XML文書の内容が同じであれば、表現形式が異なっていても同一とみなせるようにします。

まず、DOMDocumentクラスのインスタンスを作成し、loadXMLメソッドでXMLデータをロードします。次に、documentElementプロパティを使用して、XMLドキュメントのルートノードを取得します。

C14Nメソッドは、取得したノードに対してCanonical XML変換を実行します。引数として、exclusive（排他的な標準化を行うかどうか）、with_comments（コメントを含めるかどうか）、xpath（標準化するノードを選択するXPath）、ns_prefixes（名前空間プレフィックスの配列）を指定できます。このサンプルコードでは、exclusiveをtrueに設定して排他的な標準化を行い、with_commentsをfalseに設定してコメントを除外しています。他の引数は省略しています。

C14Nメソッドは、標準化されたXML文字列を返します。変換に失敗した場合はfalseを返します。サンプルコードでは、返り値がfalseでないことを確認し、成功した場合は標準化されたXML文字列を出力し、失敗した場合はエラーメッセージを出力します。このメソッドを使用することで、XMLデータの比較やデジタル署名などの処理を確実に行うことができます。