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

Copy
1<?php
2
3// DOMDocument を作成し、XML をロードします。
4$dom = new DOMDocument();
5$dom->loadXML('<root><child attribute="value">Text</child><!-- Comment --></root>');
6
7// CharacterData ノードを取得します（例：コメントノード）。
8$comment = $dom->documentElement->lastChild;
9
10// C14N を実行します。
11// exclusive, with_comments, xpath, ns_prefixes のデフォルト引数を使用します。
12$canonicalXml = $comment->C14N();
13
14// 結果を出力します。
15if ($canonicalXml !== false) {
16    echo $canonicalXml . "\n";
17} else {
18    echo "C14N failed.\n";
19}
20
21// exclusive モードで C14N を実行します。
22$canonicalXmlExclusive = $comment->C14N(true);
23
24// 結果を出力します。
25if ($canonicalXmlExclusive !== false) {
26    echo "Exclusive C14N: " . $canonicalXmlExclusive . "\n";
27} else {
28    echo "Exclusive C14N failed.\n";
29}
30?>

このサンプルコードは、PHPのDom\CharacterDataクラスのC14Nメソッドを使用して、XMLの正規化（Canonicalization）を行う方法を示しています。XMLの正規化とは、XMLドキュメントを標準的な形式に変換することです。

まず、DOMDocumentオブジェクトを作成し、XMLデータをロードします。次に、documentElementプロパティとlastChildプロパティを使用して、コメントノードを取得しています。C14Nメソッドは、このコメントノードに対してXML正規化を実行します。

C14Nメソッドの基本的な使い方は、$comment->C14N() のように引数なしで呼び出すことです。これにより、デフォルトの設定で正規化が行われます。引数には、以下のものがあります。

• $exclusive: 排他的正規化を行うかどうかを指定するブール値。
• $with_comments: コメントを含めるかどうかを指定するブール値。
• $xpath: 正規化対象のノードをXPathで指定する配列。
• $ns_prefixes: 名前空間プレフィックスの配列。

サンプルコードでは、最初に引数なしでC14Nメソッドを呼び出し、次に $exclusive = true を指定して排他的正規化を行っています。

C14Nメソッドは、正規化されたXML文字列を返します。失敗した場合はfalseを返します。サンプルコードでは、返り値がfalseでないことを確認し、正規化されたXML文字列を出力しています。C14N(true)とすることで、より厳格な排他的正規化を実行できます。これにより、より再現性の高いXMLデータを得ることができます。

Copy
1<?php
2
3// Dom\CharacterData::C14N メソッドのサンプルコード
4// XML ドキュメントを正規化 (Canonicalization) します。
5
6function canonicalize_xml_data(string $xml_string, bool $exclusive = false, bool $with_comments = false, ?array $xpath = null, ?array $ns_prefixes = null): string|false
7{
8    $dom = new DOMDocument();
9    $dom->loadXML($xml_string);
10
11    // CharacterData (Text ノードなど) を取得
12    $xpath_query = new DOMXPath($dom);
13    $text_nodes = $xpath_query->query('//text()');
14
15    if ($text_nodes === false || $text_nodes->length === 0) {
16        return false; // Text ノードが見つからない場合
17    }
18
19    $first_text_node = $text_nodes->item(0);
20
21    if ($first_text_node === null) {
22        return false; // ノードが null の場合
23    }
24
25    // C14N を実行
26    return $first_text_node->C14N($exclusive, $with_comments, $xpath, $ns_prefixes);
27}
28
29// XML 文字列の例
30$xml_string = '<root><child>Hello, World!</child><!-- comment --></root>';
31
32// C14N を実行 (コメントなし、排他的でない)
33$canonicalized_xml = canonicalize_xml_data($xml_string);
34
35if ($canonicalized_xml !== false) {
36    echo "Canonicalized XML: " . $canonicalized_xml . "\n";
37} else {
38    echo "Canonicalization failed.\n";
39}
40
41// C14N を実行 (コメントあり、排他的)
42$canonicalized_xml_with_comments = canonicalize_xml_data($xml_string, true, true);
43
44if ($canonicalized_xml_with_comments !== false) {
45    echo "Canonicalized XML (with comments, exclusive): " . $canonicalized_xml_with_comments . "\n";
46} else {
47    echo "Canonicalization failed.\n";
48}
49?>

このサンプルコードは、PHPのDom\CharacterDataクラスのC14Nメソッドを使用して、XMLドキュメントのテキストノードを正規化（Canonicalization）する方法を示します。XMLの正規化とは、XML文書を標準的な形式に変換することです。

canonicalize_xml_data関数は、XML文字列を受け取り、C14Nメソッドを呼び出して正規化されたXMLを返します。引数として、以下のものを指定できます。

• $exclusive: 排他的な正規化を行うかどうかを指定するブール値。デフォルトはfalseです。
• $with_comments: コメントを含めるかどうかを指定するブール値。デフォルトはfalseです。
• $xpath: 正規化の対象となるノードを選択するためのXPath式を指定する配列。デフォルトはnullです。
• $ns_prefixes: 名前空間プレフィックスを指定する配列。デフォルトはnullです。

関数はまず、与えられたXML文字列をDOMDocumentオブジェクトとしてロードします。次に、XPathを使用して、テキストノード（//text()）を検索します。見つかった最初のテキストノードに対してC14Nメソッドを呼び出し、正規化されたXMLを文字列として返します。正規化に失敗した場合はfalseを返します。

サンプルコードでは、コメントなし、排他的でない正規化と、コメントあり、排他的な正規化の2つの例を示しています。C14Nメソッドは、XMLデータの整合性を保つために、デジタル署名などで利用されます。