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

Copy
1<?php
2
3/**
4 * DOMDocument を C14N 1.1 形式で正規化し、文字列として返します。
5 *
6 * @param DOMDocument $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 正規化された XML 文字列。失敗した場合は false。
13 */
14function canonicalize_dom_document(DOMDocument $dom, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false
15{
16    return $dom->C14N($exclusive, $withComments, $xpath, $nsPrefixes);
17}
18
19// 使用例:
20$dom = new DOMDocument();
21$dom->loadXML('<root><child attr="value"/></root>');
22
23$canonicalXml = canonicalize_dom_document($dom);
24
25if ($canonicalXml !== false) {
26    echo $canonicalXml . PHP_EOL;
27} else {
28    echo "C14N failed." . PHP_EOL;
29}

PHPのDom\HTMLDocumentクラスのC14Nメソッドは、XMLドキュメントを正規化された文字列として取得するために使用します。この正規化は、W3Cの「Canonical XML」と呼ばれる標準に基づき、XML文書の内容を論理的に等価な形式に変換することで、異なるシステム間での比較や検証を容易にします。

C14N()メソッドは、引数として排他的C14Nの使用有無($exclusive)、コメントを含めるかどうか($with_comments)、XPath式($xpath)、名前空間プレフィックス($ns_prefixes)を受け取ります。

$exclusiveがtrueの場合、排他的C14Nが適用され、ドキュメントのコンテキスト内で宣言された名前空間のみが保持されます。$with_commentsがtrueの場合、XMLコメントも正規化された文字列に含められます。$xpath引数にXPath式の配列を指定すると、正規化の対象を特定のノードに限定できます。$ns_prefixes引数には、名前空間プレフィックスの配列を渡すことができます。

メソッドは、正規化されたXML文字列を返します。正規化に失敗した場合（例えば、ドキュメントが不正な形式の場合）、falseを返します。サンプルコードでは、canonicalize_dom_document()関数を通じてC14N()メソッドを呼び出し、結果を標準出力に表示しています。正規化されたXMLは、元のXMLドキュメントとは空白や属性の順序などが異なる場合がありますが、意味的には等価です。