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

C14Nメソッドは、XML文書を特定の規則に従って標準的な表現に変換する『正規化 (Canonicalization)』を実行するメソッドです。このメソッドは、DOMCommentクラスに属しており、XMLドキュメント内のコメントノードに対して、その正規化されたXML表現を取得するために使用されます。

XMLの正規化とは、同じ意味を持つXML文書であっても、属性の順序、名前空間宣言、空白文字の扱いといった記述方法の違いによって異なるバイト列になってしまうのを防ぎ、常に一意の標準的な表現に変換するプロセスを指します。C14Nメソッドを利用することで、このような差異を吸収し、XML文書の同一性チェックや、デジタル署名の生成・検証などにおいて、内容の正確な比較を可能にします。

このメソッドは、名前空間の扱い方や、コメント自体を最終的な出力に含めるかどうかなど、正規化の挙動を制御するための引数を受け取ることができます。特にコメントノードにおいては、正規化された出力にそのコメントを含めるかどうかが重要な設定となります。システムエンジニアがXMLベースのデータ連携やセキュリティ関連機能を開発する際、XML文書の信頼性と互換性を保証するために、このC14Nメソッドが重要な役割を果たします。これにより、異なるシステム間でのXMLデータの正確なやり取りが実現できます。

Copy
1<?php
2$document = new DOMDocument();
3$commentNode = $document->createComment('これはテストコメントです');
4
5$canonicalizedOutput = $commentNode->C14N();
6?>

bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null

• bool $exclusive: true を指定すると、コメントノード自身は正規化の対象外となり、その子ノードのみが正規化されます。
• bool $withComments: true を指定すると、コメントノードも正規化の対象に含めます。
• ?array $xpath: 正規化の対象となるノードをXPathクエリで指定します。
• ?array $nsPrefixes: 名前空間のプレフィックスとURIの連想配列を指定します。

string|false

このメソッドは、DOMCommentノードを正規化された文字列として返します。正規化に失敗した場合はfalseを返します。