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

DOMComment::C14NFileメソッドは、DOMコメントノードをCanonical XML (C14N) 形式でファイルにシリアライズするメソッドです。具体的には、DOMCommentオブジェクトが表すコメントの内容を、C14N仕様に従って整形し、指定されたファイルパスに書き込みます。

このメソッドは、XMLドキュメントの一部であるコメントノードを、他の部分との依存関係を考慮せずに、独立したXMLフラグメントとしてC14N化する必要がある場合に役立ちます。例えば、特定のコメントノードの内容を検証したり、別のXMLドキュメントに再利用したりする際に、一貫した形式で出力するために使用できます。

C14NFileメソッドは、通常のC14Nメソッドとは異なり、結果を文字列として返すのではなく、直接ファイルに書き込む点が特徴です。そのため、大きなコメントノードを扱う場合に、メモリ使用量を抑えることができます。

メソッドの引数には、出力先のファイルのパスを指定します。ファイルパスは文字列で指定し、書き込み権限のある場所を指定する必要があります。また、オプションで、C14Nの処理をカスタマイズするための引数を指定することもできます。例えば、名前空間の処理方法や、コメントの保持などを制御できます。

このメソッドは、XMLドキュメントの正規化処理において、特定のコメントノードのみをファイルに書き出す必要がある場合に有効です。システム開発においては、設定ファイルやログファイルのコメント部分を正規化して保存するなどの用途が考えられます。

Copy
1DOMComment::C14NFile( string $uri, bool $exclusive = false, bool $with_comments = false, array $namespaces = [], string $inclusive_prefixes = null ): int|false

string $uri, bool $exclusive = false, bool $with_comments = false, ?array $xpath = null, ?array $ns_prefixes = null

• string $uri: 正規化するDOMDocumentのURIを指定します。
• bool $exclusive = false: trueを指定すると、指定されたURIにのみ適用される排他ロックが使用されます。
• bool $with_comments = false: trueを指定すると、コメントノードも正規化に含めます。
• ?array $xpath = null: 正規化の対象となるノードをXPathクエリで指定します。
• ?array $ns_prefixes = null: 正規化時に使用する名前空間プレフィックスを配列で指定します。

string|false

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