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

Copy
1<?php
2
3/**
4 * 指定したDOMノードをC14N (Canonical XML) 形式の文字列に変換します。
5 *
6 * @param DOMNode $node 変換するDOMノード
7 * @param bool $exclusive 排他的C14Nを使用するかどうか (デフォルト: false)
8 * @param bool $withComments コメントを含めるかどうか (デフォルト: false)
9 * @param array|null $xpath XPath 式の配列 (デフォルト: null)
10 * @param array|null $nsPrefixes 名前空間プレフィックスの配列 (デフォルト: null)
11 *
12 * @return string|false C14N 形式の文字列、またはエラー時に false
13 */
14function generateC14N(DOMNode $node, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false
15{
16    return $node->C14N($exclusive, $withComments, $xpath, $nsPrefixes);
17}
18
19// 使用例
20$dom = new DOMDocument();
21$dom->loadXML('<root><element attribute="value">text</element></root>');
22
23$rootElement = $dom->documentElement;
24
25if ($rootElement) {
26    $c14nString = generateC14N($rootElement);
27
28    if ($c14nString !== false) {
29        echo $c14nString . PHP_EOL;
30    } else {
31        echo "C14N conversion failed." . PHP_EOL;
32    }
33} else {
34    echo "Root element not found." . PHP_EOL;
35}
36
37?>

PHPのDom\HTMLElementクラスのC14Nメソッドは、XMLドキュメントの一部を、C14N（Canonical XML）と呼ばれる標準化された形式の文字列に変換するために使用します。C14Nは、XMLドキュメントの見た目が異なっていても、論理的に同じ内容であれば同じ文字列を生成することを目的としています。

このメソッドは、以下の引数を持ちます。$exclusiveは、排他的C14Nを使用するかどうかを指定するブール値で、デフォルトはfalseです。$withCommentsは、XMLコメントを含めるかどうかを指定するブール値で、デフォルトはfalseです。$xpathは、処理対象をXPath式で絞り込むための配列で、デフォルトはnullです。$nsPrefixesは、名前空間プレフィックスの配列で、デフォルトはnullです。

サンプルコードでは、generateC14N関数を作成し、DOMノードをC14N形式の文字列に変換しています。まず、DOMDocumentオブジェクトを作成し、XML文字列を読み込みます。次に、ルート要素を取得し、generateC14N関数を使ってC14N形式に変換します。変換が成功すると、C14N形式の文字列が出力されます。変換に失敗した場合は、エラーメッセージが出力されます。

C14Nメソッドは、XMLデータのデジタル署名や、XMLデータの比較など、XMLデータの信頼性を確保する必要がある場面で役立ちます。戻り値は、C14N形式の文字列、またはエラー時に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: 排他的な C14N を実行するかどうか (デフォルト: false)
12// $withComments: コメントを含めるかどうか (デフォルト: false)
13// $xpath: C14N の対象とするノードを選択する XPath 式 (デフォルト: null)
14// $nsPrefixes: 名前空間プレフィックスのリスト (デフォルト: null)
15$canonicalXml = $root->C14N(exclusive: true, withComments: false);
16
17// 結果を出力
18if ($canonicalXml !== false) {
19    echo $canonicalXml . PHP_EOL;
20} else {
21    echo "C14N failed." . PHP_EOL;
22}
23

このPHPのサンプルコードは、Dom\HTMLElementクラスのC14Nメソッドを使用して、XMLドキュメントの特定の部分をCanonical XML（C14N）形式に変換する方法を示しています。C14Nは、XMLドキュメントを標準化された形式に変換するプロセスで、デジタル署名やXMLデータの比較などの目的で使用されます。

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

C14Nメソッドは、このルート要素に対して実行されます。引数には、以下のものが指定可能です。

• $exclusive: 排他的C14N (C14N 1.1) を実行するかどうかを指定します。trueに設定すると、ドキュメントのサブツリーのみを正規化し、ルートノードの祖先から到達可能な名前空間宣言を含めます。デフォルトはfalseです。
• $withComments: コメントを含めるかどうかを指定します。デフォルトはfalseです。
• $xpath: C14Nの対象とするノードをXPath式で指定します。nullの場合、ルート要素全体が対象となります。
• $nsPrefixes: 正規化された出力に含める名前空間プレフィックスのリストを指定します。

サンプルコードでは、exclusiveをtrueに設定し、withCommentsをfalseに設定しています。これにより、排他的C14Nがコメントを含めずに行われます。

C14Nメソッドは、Canonical XML形式の文字列を返します。処理に失敗した場合はfalseを返します。サンプルコードでは、戻り値がfalseでないかを確認し、成功した場合は結果を出力し、失敗した場合はエラーメッセージを出力します。この例では、XMLドキュメントをC14N形式に変換し、その結果を標準出力に出力します。