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

Copy
1<?php
2
3/**
4 * DOMDocument::createCDATASection メソッドの使用例。
5 * CDATAセクションは、XMLパーサーが解析しない生のテキストコンテンツを
6 * XMLドキュメント内に含める際に使用されます。
7 */
8
9// 1. DOMDocument のインスタンスを作成
10// XMLのバージョンとエンコーディングを指定します。
11$dom = new DOMDocument('1.0', 'UTF-8');
12
13// 2. ルート要素を作成し、DOMドキュメントに追加
14// <root> 要素を作成します。
15$rootElement = $dom->createElement('root');
16$dom->appendChild($rootElement);
17
18// 3. createCDATASection() メソッドを使用して CDATA セクションを作成
19// ここでは、XMLとして解釈されたくない特殊文字やHTMLタグを含むテキストを用意します。
20$rawText = "このテキストには <p>HTMLタグ</p> や &lt;script&gt; タグ、
21            そして &amp; エンティティ参照が含まれています。";
22$cdataSection = $dom->createCDATASection($rawText);
23
24// 4. 作成した CDATA セクションをルート要素に追加
25// <root> 要素の子として CDATA セクションを追加します。
26$rootElement->appendChild($cdataSection);
27
28// 5. 生成された XML を出力
29// 出力を整形して見やすくします。
30$dom->formatOutput = true;
31echo $dom->saveXML();
32
33?>

PHPのDOMDocument::createCDATASectionメソッドは、XMLドキュメント内に「CDATAセクション」を作成する際に利用します。CDATAセクションは、XMLパーサーがその内容を解析しない、生のテキストコンテンツをXMLに含めたい場合に特に有効です。例えば、HTMLタグやXMLの特殊文字（<や&など）を、そのままの形でXMLドキュメント内に記述したいときに役立ちます。

このメソッドは、引数としてstring $dataを受け取ります。この$dataには、CDATAセクションとして扱いたい生の文字列を指定します。戻り値は、新しく作成されたDOMCDATASectionオブジェクトです。このオブジェクトは、他の要素ノードと同様に、XMLドキュメントツリーの任意の場所に子ノードとして追加できます。

サンプルコードでは、まずDOMDocumentのインスタンスを作成し、XMLドキュメントの基盤を準備しています。次に、createElementメソッドで<root>要素を作成し、ドキュメントのルート要素として追加しています。そして、createCDATASectionメソッドに、HTMLタグやXMLの特殊文字を含むテキストを渡してCDATAセクションを作成します。作成されたCDATAセクションは、appendChildメソッドを使って<root>要素の子として追加されます。最終的にsaveXMLでドキュメント全体を出力することで、指定したテキストがCDATAセクションとしてXML内に埋め込まれていることを確認できます。これにより、XMLの構文に干渉することなく、任意のテキストデータを安全にXMLドキュメント内に格納することが可能になります。

Copy
1<?php
2
3/**
4 * データベース接続設定と、データベース作成のためのサンプルSQLクエリを含むXMLファイルを生成します。
5 * パスワードやSQLクエリなど、特殊文字を含む可能性のあるデータはCDATAセクションとして埋め込まれ、
6 * XMLパーサーによる誤った解釈を防ぎます。
7 *
8 * @param string $host データベースサーバーのホスト名
9 * @param string $user データベースユーザー名
10 * @param string $password データベースパスワード
11 * @param string $dbName 作成または接続するデータベース名
12 * @return string 生成されたXMLドキュメントの文字列
13 */
14function generateDatabaseConfigAndQueryXml(
15    string $host,
16    string $user,
17    string $password,
18    string $dbName
19): string {
20    // DOMDocumentを初期化（XMLバージョンとエンコーディングを指定）
21    $dom = new DOMDocument('1.0', 'UTF-8');
22    // 出力されるXMLを見やすくするためにフォーマットを有効にする
23    $dom->formatOutput = true;
24
25    // ルート要素 <database-configuration> を作成し、ドキュメントに追加
26    $root = $dom->createElement('database-configuration');
27    $dom->appendChild($root);
28
29    // <connection-settings> 要素を作成し、ルートに追加
30    $connectionSettings = $dom->createElement('connection-settings');
31    $root->appendChild($connectionSettings);
32
33    // ホスト名、ユーザー名を要素として追加
34    $connectionSettings->appendChild($dom->createElement('host', $host));
35    $connectionSettings->appendChild($dom->createElement('user', $user));
36
37    // パスワード要素を作成
38    $passwordNode = $dom->createElement('password');
39    // パスワードをCDATAセクションとして追加
40    // CDATAセクション内のデータはXMLパーサーによって解析されず、プレーンテキストとして扱われます。
41    // これは、パスワードに含まれる特殊文字がXML構文と衝突するのを防ぐのに役立ちます。
42    $cdataPassword = $dom->createCDATASection($password);
43    $passwordNode->appendChild($cdataPassword);
44    $connectionSettings->appendChild($passwordNode);
45
46    // データベース名要素を追加
47    $connectionSettings->appendChild($dom->createElement('database-name', $dbName));
48
49    // データベースを作成するためのサンプルSQLクエリをCDATAセクションとして追加
50    // 複雑なSQLクエリ文字列をXMLドキュメント内に埋め込む際に、
51    // 特殊文字をエスケープする手間を省き、コードの可読性を保つことができます。
52    $createDatabaseQuery = "CREATE DATABASE IF NOT EXISTS `{$dbName}` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;";
53    $queryNode = $dom->createElement('create-database-sql');
54    $cdataQuery = $dom->createCDATASection($createDatabaseQuery);
55    $queryNode->appendChild($cdataQuery);
56    $root->appendChild($queryNode);
57
58    // 生成されたXMLを文字列として返す
59    return $dom->saveXML();
60}
61
62// サンプルデータ
63$dbHost = 'localhost';
64$dbUser = 'app_user';
65// 実際のパスワードを想定。特殊文字が含まれていても問題ありません。
66$dbPassword = 'S3cr3tP@ssw0rd!#$<&>"\'';
67$dbName = 'my_application_db';
68
69// XML生成関数を呼び出す
70$xmlOutput = generateDatabaseConfigAndQueryXml($dbHost, $dbUser, $dbPassword, $dbName);
71
72// 生成されたXMLを出力
73echo $xmlOutput;
74
75?>

PHPのDOMDocument::createCDATASectionメソッドは、XMLドキュメント内で特殊文字を含むテキストデータを安全に埋め込むためのCDATAセクションを作成します。このサンプルコードでは、PHP 8のDOMDocumentクラスを用いて、データベース接続設定とデータベース作成用のSQLクエリを含むXMLファイルを生成しています。特に、パスワードやSQLクエリのように、XMLの構文と衝突する可能性のある特殊文字（<、>、&など）が含まれるデータは、createCDATASectionメソッドによってCDATAセクションとして扱われます。

createCDATASectionメソッドの引数string $dataには、CDATAセクションとしてXMLドキュメントに含めたい文字列を渡します。このメソッドは、生成されたDOMCDATASectionオブジェクトを戻り値として返します。CDATAセクション内のデータはXMLパーサーによって解析されず、プレーンテキストとして解釈されるため、データに含まれる特殊文字がXML構文を壊す心配がなく、エスケープ処理の手間を省き、データの可読性を高く保つことができます。この例では、ユーザーパスワードとCREATE DATABASEのSQLクエリがCDATAセクション内に格納されており、安全かつ正確にXMLドキュメントの一部として扱われています。生成されるXMLドキュメントは、データベース接続情報とクエリ設定を外部ファイルとして管理するのに役立ちます。