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

Dom\NotationクラスのC14NFileメソッドは、ノードをCanonical XML（C14N）形式でファイルにシリアライズするメソッドです。C14Nは、XMLドキュメントを正規化するための標準規格であり、XMLドキュメントの内容が変わらない限り、表現形式の違いを吸収して一意な形式に変換することを目的としています。このメソッドを使用することで、Dom\Notationノードの内容をC14N形式でファイルに保存できます。

具体的には、C14NFileメソッドは、指定されたノードをC14N形式に変換し、その結果を指定されたファイルパスに書き込みます。この処理は、XMLデータの整合性を保証したり、異なるシステム間でXMLデータを交換する際に役立ちます。たとえば、デジタル署名を作成する前にXMLドキュメントを正規化することで、署名の検証を確実に行うことができます。

C14NFileメソッドは、ファイルパスを引数として受け取ります。必要に応じて、C14Nのバージョンや、コメントの保持、空のノードの処理方法などを制御するためのオプションを指定することも可能です。C14NFileメソッドを使用することで、Dom\Notationノードを簡単にCanonical XML形式でファイルに保存し、XMLデータの相互運用性を高めることができます。システムエンジニアは、このメソッドを利用することで、XMLデータを扱うアプリケーションにおいて、データの整合性や互換性を確保することができます。

Copy
1Dom\Notation::C14NFile( ?string $uri, bool $exclusive = false, bool $with_comments = false, ?array $xpath = null, ?string $nsPrefixes = null ): int|false

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

• string $uri: 正規化するXMLファイルのURIを指定します。
• bool $exclusive = false: trueの場合、指定されたXPath式に一致する要素のみを正規化します。
• bool $withComments = false: trueの場合、XMLコメントも正規化に含めます。
• ?array $xpath = null: 正規化する要素を指定するXPath式の配列です。
• ?array $nsPrefixes = null: 名前空間のプレフィックスとURIの対応を指定する配列です。

int|false

C14NFileメソッドは、XML文書を正規化してファイルに保存し、成功した場合は1、失敗した場合はfalseを返します。