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

Copy
1<?php
2
3/**
4 * Dom\CDATASection::C14N メソッドの使用例をデモンストレーションします。
5 * C14N (Canonical XML) は、XML ドキュメントの標準化されたバイト表現を生成するのに使用されます。
6 * これにより、異なるXMLの表現が同じ論理的意味を持つ場合に、同じバイト列に変換されることが保証されます。
7 */
8function demonstrateC14NOnCDATASection(): void
9{
10    // 1. DOMDocument オブジェクトを作成します。
11    // XML ドキュメント全体を操作するための基盤となります。
12    $dom = new DOMDocument('1.0', 'UTF-8');
13    $dom->formatOutput = true; // 出力を見やすくするための設定です。C14Nの動作には影響しません。
14
15    // 2. ルート要素 'root' を作成し、ドキュメントに追加します。
16    $root = $dom->createElement('root');
17    $dom->appendChild($root);
18
19    // 3. 子要素 'data' を作成し、'root' 要素に追加します。
20    $dataElement = $dom->createElement('data');
21    $root->appendChild($dataElement);
22
23    // 4. CDATASection の内容となる文字列を定義します。
24    // CDATASection 内のテキストは、XMLパーサーによってマークアップとして解釈されません。
25    // ここではHTMLのような文字列を例としています。
26    $cdataContent = '<script>alert("Hello XML!");</script>';
27
28    // 5. Dom\CDATASection オブジェクトを作成します。
29    // createCDATASection() メソッドは、指定された内容で新しい CDATASection ノードを作成します。
30    $cdataSection = $dom->createCDATASection($cdataContent);
31
32    // 6. 作成した CDATASection を 'data' 要素の子として追加します。
33    $dataElement->appendChild($cdataSection);
34
35    echo "--- オリジナルXMLドキュメント ---\n";
36    // saveXML() は DOMDocument オブジェクトの現在のXML表現を文字列として返します。
37    echo $dom->saveXML() . "\n\n";
38
39    // 7. Dom\CDATASection オブジェクトに対して C14N メソッドを呼び出します。
40    // C14N() メソッドは、現在のノード（この場合は CDATASection）の正規化されたXML文字列を生成します。
41    // 引数は全てデフォルト値 (exclusive=false, with_comments=false, xpath=null, ns_prefixes=null) を使用します。
42    $canonicalizedXml = $cdataSection->C14N();
43
44    if ($canonicalizedXml !== false) {
45        echo "--- Dom\\CDATASection::C14N() による正規化された出力 ---\n";
46        echo $canonicalizedXml . "\n";
47        echo "Dom\\CDATASection::C14N() メソッドは、対象のCDATAセクションとその周囲のXMLコンテキスト\n";
48        echo "（親要素の名前空間宣言など）を考慮して正規化を行います。\n";
49        echo "この例では、CDATAセクションの内容がほぼそのまま出力されますが、XML全体として見ると、\n";
50        echo "名前空間や属性、エンコーディングといった要素が複雑な場合にその影響がより明確になります。\n";
51    } else {
52        echo "エラー: C14N() メソッドの実行に失敗しました。\n";
53    }
54}
55
56// 関数を実行し、デモンストレーションを開始します。
57demonstrateC14NOnCDATASection();
58
59?>

PHPのDom\CDATASection::C14Nメソッドは、XMLドキュメント内のCDATAセクションを「正規化されたXML文字列」に変換します。C14N（Canonical XML）とは、XMLの異なる記述形式が論理的に同じ意味を持つ場合でも、常に一貫したバイト列に統一する標準化技術です。これにより、XMLデータの正確な比較やデジタル署名の整合性検証といった場面で信頼性を高めます。

このサンプルコードでは、まずDOMDocumentオブジェクトでXML構造を作成し、その中に<data>要素と、HTMLのような文字列を含むDom\CDATASectionを追加しています。createCDATASection()メソッドは、指定された内容で新しいCDATAセクションノードを生成し、XMLツリーに組み込みます。CDATAセクション内のテキストはXMLパーサーによって通常のマークアップとしては解釈されず、内容がそのまま保持される特殊なブロックです。

その後、作成した$cdataSectionオブジェクトに対してC14N()メソッドを呼び出しています。このメソッドは、対象のCDATAセクションから正規化されたXML文字列を返します。引数$exclusiveや$with_comments、$xpath、$ns_prefixesは、正規化の挙動を細かく調整するためのオプションですが、この例では全てデフォルト値を使用しています。メソッドが成功した場合は正規化されたXML文字列を返し、失敗した場合はfalseを返します。この機能は、XMLデータの一貫性を保証する上で重要な役割を果たします。

Copy
1<?php
2
3/**
4 * Dom\CDATASection::C14N メソッドの使用例を示します。
5 *
6 * この関数は、XMLドキュメント内のCDATAセクションノードを取得し、
7 * そのノードに対してXMLの正規化（Canonicalization, C14N）を適用する方法をデモンストレーションします。
8 *
9 * キーワード "c14n11" はXML Canonicalization 1.1を指しますが、
10 * Dom\Node::C14N メソッドは主にXML Canonicalization 1.0 および Exclusive Canonicalization 1.0 に対応しています。
11 * Dom\CDATASection ノード単体の正規化は、そのテキストコンテンツをそのまま返すことが多く、
12 * XML構造全体の正規化とは異なる点に注意が必要です。
13 *
14 * システムエンジニアを目指す初心者向けに、簡潔かつ正確なコードを提供します。
15 */
16function demonstrateCdataSectionC14N(): void
17{
18    // サンプル XML ドキュメントを定義
19    $xmlString = <<<XML
20<root xmlns:ex="http://example.com/ns">
21    <data attr="value">
22        <!-- これはXMLコメントです -->
23        <![CDATA[This is <b>CDATA</b> content with <special> characters & entities.</special>]]>
24    </data>
25    <info>Some other text.</info>
26</root>
27XML;
28
29    // Dom\Document オブジェクトを作成し、XML をロード
30    $dom = new Dom\Document();
31    $dom->loadXML($xmlString);
32
33    echo "オリジナル XML:\n";
34    // `saveXML()` は、XML宣言や適切なインデントを含む整形されたXMLを出力します。
35    echo $dom->saveXML();
36    echo "\n";
37
38    // CDATASection ノードを検索
39    $cdataSection = null;
40    $dataElements = $dom->getElementsByTagName('data');
41    if ($dataElements->count() > 0) {
42        // 'data' 要素の子ノードを走査し、Dom\CDATASection のインスタンスを見つける
43        foreach ($dataElements->item(0)->childNodes as $node) {
44            if ($node instanceof Dom\CDATASection) {
45                $cdataSection = $node;
46                break; // 最初に見つかった CDATASection を使用
47            }
48        }
49    }
50
51    if ($cdataSection !== null) {
52        echo "取得した CDATASection のテキストコンテンツ:\n";
53        echo $cdataSection->textContent . "\n\n";
54
55        // --- Dom\CDATASection::C14N メソッドの呼び出し例 ---
56
57        // 1. 標準的な C14N (XML C14N 1.0)
58        // 引数: exclusive=false (標準正規化), with_comments=false (コメントを含まない)
59        // CDATASection ノード単体のC14Nは、その生のテキストコンテンツを返します。
60        // XML構造（要素、属性、名前空間）の正規化とは異なり、CDATA内部のテキストは変更されません。
61        echo "CDATASection の C14N (標準、コメントなし):\n";
62        $c14nResultStandard = $cdataSection->C14N(false, false);
63        if ($c14nResultStandard !== false) {
64            echo $c14nResultStandard . "\n\n";
65        } else {
66            echo "C14N 処理に失敗しました。\n\n";
67        }
68
69        // 2. 排他的 C14N (Exclusive XML C14N 1.0)
70        // 引数: exclusive=true (排他的正規化), with_comments=false (コメントを含まない)
71        // 排他的正規化は名前空間宣言の伝播を制御しますが、CDATASection ノード自体は名前空間を持たないため、
72        // この例では標準C14Nと同じ結果になります。
73        echo "CDATASection の C14N (排他的、コメントなし):\n";
74        $c14nResultExclusive = $cdataSection->C14N(true, false);
75        if ($c14nResultExclusive !== false) {
76            echo $c14nResultExclusive . "\n\n";
77        } else {
78            echo "C14N (排他的) 処理に失敗しました。\n\n";
79        }
80
81        // 3. コメントを含む標準 C14N
82        // 引数: exclusive=false (標準正規化), with_comments=true (コメントを含む)
83        // Dom\CDATASection ノード自体はコメントを持たないため、この引数を true にしても
84        // このノード単体のC14N結果に直接的な変化はありません。コメントは親ノードに属します。
85        echo "CDATASection の C14N (標準、コメントあり):\n";
86        $c14nResultWithComments = $cdataSection->C14N(false, true);
87        if ($c14nResultWithComments !== false) {
88            echo $c14nResultWithComments . "\n\n";
89        } else {
90            echo "C14N (コメントあり) 処理に失敗しました。\n\n";
91        }
92
93    } else {
94        echo "エラー: XML ドキュメントから CDATASection ノードが見つかりませんでした。\n";
95    }
96}
97
98// サンプル関数を実行
99demonstrateCdataSectionC14N();
100

PHPのDom\CDATASection::C14Nメソッドは、XMLドキュメント内のCDATAセクションノードに対してXMLの正規化（Canonicalization, C14N）を適用する際に使用されます。C14Nは、XMLドキュメントの内容が論理的に等しいかを判断するために、見た目や記述方法の違いを吸収し、一貫した表現形式に変換するプロセスです。

このメソッドは、第一引数$exclusiveで排他的C14N（名前空間の扱いを限定する方式）を行うかを、第二引数$with_commentsで正規化結果にコメントを含めるかを真偽値で指定します。オプションの$xpathや$ns_prefixes引数は、正規化の対象を絞り込むために使われます。処理が成功すると正規化されたXMLの文字列が返され、失敗した場合はfalseが戻り値となります。

サンプルコードでは、XMLドキュメントからCDATAセクションノードを見つけ出し、そのノードに対してC14Nメソッドを呼び出しています。CDATAセクションノード単体での正規化は、通常、その内部のテキストコンテンツをそのまま出力します。これは、XMLドキュメント全体を構成する要素や属性、名前空間宣言などを対象とする正規化とは異なり、CDATA内部のテキスト自体が変更されることはありません。そのため、$exclusiveや$with_comments引数の設定が、CDATAセクション単体のC14N結果に直接的な影響を与えることは少ないです。なお、このメソッドは主にXML Canonicalization 1.0に対応しており、キーワードの"c14n11"が示すより新しいバージョンとは直接的な関係はありません。