【PHP8.x】DOMCdataSection::C14N()メソッドの使い方

C14Nメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年11月29日

基本的な使い方

C14Nメソッドは、XMLドキュメント内のCDATAセクションを表すDOMCdataSectionオブジェクトの内容を、Canonical XML（C14N）形式で正規化し、その結果を文字列として返すメソッドです。Canonical XMLとは、XMLドキュメントの物理的な表現の差異（例えば、空白文字の扱い、属性の順序、名前空間宣言の表記方法など）を吸収し、論理的に等価なXMLドキュメントであれば常に同じバイト列に変換する標準的なアルゴリズムです。

この正規化は、主にXMLドキュメントのデジタル署名やハッシュ計算において、ドキュメントの同一性を厳密に保証するために非常に重要です。異なる記述形式を持つが内容的には同じXMLが、確実に同じ署名やハッシュ値を生成できるようにします。

C14Nメソッドには、オプションとして排他的C14N（Exclusive C14N）モードを有効にするかどうか、またXMLコメントを含めるかどうかを真偽値で指定できます。排他的C14Nモードは、名前空間の宣言をより厳密に制御し、ドキュメントの特定の部分のみを正規化する際に使用されます。コメントを含めるかどうかは、正規化された出力にXMLコメントが含まれるかどうかに影響します。

本メソッドは、CDATAセクション内のテキストデータが、上記の正規化規則に従って統一された形式で出力されることを保証します。これにより、XMLデータの整合性検証や、セキュアな情報交換を行うシステムにおいて不可欠な機能を提供します。

構文(syntax)


1<?php
2$document = new DOMDocument();
3$cdataNode = $document->createCDATASection('Example CDATA content');
4$normalizedOutput = $cdataNode->C14N();

引数(parameters)

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

bool $exclusive: trueの場合、排他的な正規化を行います。デフォルトはfalseです。
bool $withComments: trueの場合、コメントを含めて正規化します。デフォルトはfalseです。
?array $xpath: 正規化の対象となるXPathノードの配列を指定します。nullの場合はすべてのノードが対象となります。
?array $nsPrefixes: 名前空間のプレフィックスをマッピングする配列を指定します。nullの場合はすべての名前空間が対象となります。

戻り値(return)

string|false

このメソッドは、C14N（Canonical XML）形式の文字列を返します。C14N形式は、XML文書を正規化するための標準的な方法です。変換に失敗した場合は false を返します。

サンプルコード

PHP: DOMCdataSection::C14N でXML正規化する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMCdataSection::C14N の使用例を示します。
7 *
8 * XMLドキュメント内のCDATAセクションノードを正規化（Canonicalization）し、
9 * 標準的な文字列表現に変換します。
10 */
11function cdataSectionC14NExample(): void
12{
13    // 1. CDATAセクションを含むXML文字列を準備します。
14    // CDATAセクションは、XMLパーサーに解釈させたくないテキストを囲むために使用します。
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="UTF-8"?>
17<document>
18  <script>
19    <

このPHPコードは、XMLドキュメント内の特定のCDATAセクションノードを「正規化（C14N）」するDOMCdataSection::C14N()メソッドの使用例です。正規化とは、XMLデータを誰が処理しても同じ結果になるよう、一貫性のある標準的な形式に変換する処理を指します。電子署名などでデータの一致性を検証する際に重要となります。

サンプルコードでは、まずDOMDocumentクラスを使ってCDATAセクションを含むXML文字列を読み込み、DOMオブジェクトを生成します。次に、getElementsByTagNameなどを利用して操作対象のCDATAセクションノードを取得しています。

C14N()メソッドをこのノードに対して呼び出すと、CDATAセクションの開始タグ`<

このコードは、XML文書内の特定のCDATAセクションを正規化するものです。注意点として、C14NメソッドはCDATAセクションのノードオブジェクトに対して呼び出す必要があります。サンプルコードのようにXPathでノードを取得する場合、対象が見つからずnullが返る可能性があるため、必ず存在確認とinstanceofによる型チェックを行ってください。また、メソッドの戻り値は処理に失敗するとfalseを返すため、文字列として利用する前にfalseでないかを確認することが安全です。この処理は単にテキストを取得するのとは異なり、デジタル署名などで使われる標準的な文字列表現に変換します。そのため、CDATA内の<や>といった文字は<や>のようにエスケープされて出力されます。

PHP DOMCdataSection::C14NでCDATAを正規化する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMCdataSection::C14N() を使用してCDATAセクションを正規化するサンプル
7 *
8 * この関数は、XMLドキュメント内のCDATAセクションを取得し、
9 * Canonical XML (C14N) 形式の文字列に変換して表示します。
10 *
11 * @return void
12 */
13function demonstrateCdataCanonicalization(): void
14{
15    // CDATAセクションを含むサンプルXML文字列を定義します。
16    // CDATAセクション内には、XMLとして解釈されうる文字 '<', '>', '&' が含まれています。
17    $xmlString = <<<XML
18<?xml version="1.0" encoding="UTF-8"?>
19<document>
20  <data><

このサンプルコードは、PHPのDOMCdataSection::C14N()メソッドを使い、XML文書内のCDATAセクションを正規化（C14N）する方法を示しています。正規化とは、意味的に同じXML文書を、テキスト表現としても完全に同一にするための統一ルールのことです。これにより、XMLデータの一貫性を保証しやすくなります。

コードでは、まずCDATAセクションを含むXML文字列をDOMDocumentオブジェクトとして読み込みます。次に、特定の要素から子ノードとしてDOMCdataSectionオブジェクトを取得します。このオブジェクトに対してC14N()メソッドを呼び出すと、CDATAセクションが正規化された文字列に変換されます。

この変換プロセスでは、`<

この関数はCDATAセクションの特殊な囲い（<![CDATA[...]]>）を取り除き、中のテキストデータをそのまま文字列として返します。そのため、元々CDATA内にあった<や&のようなXML特殊文字が、エスケープされずにそのまま出力される点に注意が必要です。この文字列を別のXMLやHTMLに組み込む際は、意図しない解釈で構造が壊れるのを防ぐために、別途エスケープ処理が必要になる場合があります。また、処理に失敗するとfalseが返るため、必ず戻り値を確認する習慣をつけましょう。対象のノードがDOMCdataSectionでないとエラーになるため、ノードの取得方法と型の確認も重要です。