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

C14Nメソッドは、DOMEntityノードをCanonical XML形式でシリアライズするメソッドです。DOMEntityは、XMLドキュメント内でエンティティを参照するノードを表します。C14Nメソッドを使用することで、エンティティノードの内容を標準化されたXML形式の文字列として取得できます。

このメソッドは、XMLドキュメントのデジタル署名や、異なるシステム間でのXMLデータの整合性検証において重要な役割を果たします。Canonical XMLは、XMLドキュメントの論理的な意味内容を変えずに、表現形式を統一することを目的としています。これにより、空白、属性の順序、名前空間のプレフィックスなどの違いによって、XMLドキュメントが異なると判断されるのを防ぎます。

C14Nメソッドは、エンティティノードをCanonical XML形式に変換することで、エンティティの内容が一意に表現されることを保証します。これにより、エンティティの内容に基づく処理や比較を、環境に依存せずに行うことが可能になります。例えば、あるXMLドキュメントのエンティティの内容を別のシステムで検証する際に、C14Nメソッドを使用することで、両方のシステムで同じ結果が得られることを保証できます。

このメソッドは、XML処理において高度な制御が必要な場合に特に有用です。標準化されたXML形式を用いることで、セキュリティリスクを低減し、相互運用性を高めることができます。DOMEntityノードのC14Nメソッドを使用することで、XMLドキュメントの特定の部分を標準化された形式で抽出し、様々な目的に利用することができます。

Copy
1DOMEntity::C14N(
2    ?string $exclusive = null,
3    bool $withComments = false,
4    ?array $namespaces = null,
5    ?string $prefix = null
6): string|false

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

• bool $exclusive = false: 包含するエンティティの範囲を排他的にするかどうかを示すブール値。true の場合、指定されたノードのみが対象となります。
• bool $withComments = false: コメントノードを含めるかどうかを示すブール値。
• ?array $xpath = null: 正規化の対象とするノードをXPath式で指定する配列。null の場合はすべてのノードが対象となります。
• ?array $nsPrefixes = null: 名前空間のプレフィックスを正規化の対象として指定する配列。null の場合はすべての名前空間が対象となります。

bool

この C14N メソッドは、エンティティの正規化が成功したかどうかを示す真偽値（boolean）を返します。正規化が成功した場合は true を、失敗した場合は false を返します。