【PHP8.x】Dom\CDATASection::wholeTextプロパティの使い方

Copy
1<?php
2
3/**
4 * Dom\CDATASection からテキストを取得し、それが数字のみで構成されているかを判定するサンプル関数。
5 *
6 * この関数は、XMLドキュメント内で特殊なデータを扱うCDATAセクションの基本的な使用方法と、
7 * その内容が「数字のみ」であるかを検証する方法を、システムエンジニアを目指す初心者向けに示します。
8 */
9function processCdataSectionText(): void
10{
11    // 1. 新しいDOMドキュメントを作成します。これはXMLやHTMLの構造を構築するための土台となります。
12    $dom = new DOMDocument('1.0', 'UTF-8');
13
14    // 2. ルート要素 'data' を作成し、ドキュメントに追加します。
15    //    CDATAセクションは通常、何らかの要素の子として配置されます。
16    $root = $dom->createElement('data');
17    $dom->appendChild($root);
18
19    // 3. 数字のみを含むCDATAセクションを作成します。
20    //    CDATAセクションは、内部のテキストがXML/HTMLパーサーによってマークアップとして解釈されず、
21    //    純粋なテキストデータとして扱われることを保証します。
22    //    ここでは「1234567890」という数字のみの文字列を格納します。
23    $numericCdata = $dom->createCDATASection('1234567890');
24
25    // 4. 作成したCDATAセクションをルート要素の子として追加します。
26    $root->appendChild($numericCdata);
27
28    // 5. Dom\CDATASection オブジェクトの wholeText プロパティを使用して、
29    //    CDATAセクションに含まれるテキスト全体を文字列として取得します。
30    //    このプロパティは、ノードとその隣接するテキストノードの全てのテキストデータを連結して返します。
31    $textFromCdata = $numericCdata->wholeText;
32
33    echo "CDATAセクションから取得したテキスト: " . $textFromCdata . PHP_EOL;
34
35    // 6. 取得したテキストが「数字のみ」で構成されているかを判定します。
36    //    ctype_digit() 関数は、文字列が全て数字（0-9）で構成されている場合に true を返します。
37    if (ctype_digit($textFromCdata)) {
38        echo "→ このテキストは数字のみで構成されています。" . PHP_EOL;
39    } else {
40        echo "→ このテキストには数字以外の文字が含まれています。" . PHP_EOL;
41    }
42
43    echo PHP_EOL; // 区切り用に改行
44
45    // 別の例: 数字以外の文字を含むCDATAセクション
46    $mixedCdata = $dom->createCDATASection('Version-1.2.3');
47    $root->appendChild($mixedCdata);
48    $textFromMixedCdata = $mixedCdata->wholeText;
49
50    echo "CDATAセクションから取得したテキスト (数字以外を含む): " . $textFromMixedCdata . PHP_EOL;
51
52    if (ctype_digit($textFromMixedCdata)) {
53        echo "→ このテキストは数字のみで構成されています。" . PHP_EOL;
54    } else {
55        echo "→ このテキストには数字以外の文字が含まれています。" . PHP_EOL;
56    }
57}
58
59// 上記で定義した関数を実行して、CDATAセクションのテキスト取得と数字判定の動作を確認します。
60processCdataSectionText();

PHP 8のDom\CDATASectionクラスが持つwholeTextプロパティは、XMLドキュメント内で特殊なテキストデータを扱うCDATASectionノードの内容を、マークアップとして解釈されずに純粋な文字列として取得するために利用されます。このプロパティは引数を受け取らず、常にstring型のテキスト値を返します。

サンプルコードでは、まずDOMDocumentとcreateElementを用いてXMLの基本的な構造を構築しています。次に、createCDATASectionメソッドを使用して、「1234567890」のように数字のみで構成されたテキストを含むCDATASectionノードを作成し、これをドキュメントに追加しています。

作成されたDom\CDATASectionオブジェクトのwholeTextプロパティにアクセスすることで、CDATAセクション内に格納されているテキスト「1234567890」を文字列として取得できます。取得したこの文字列に対して、PHPのctype_digit()関数を使用すると、その文字列が全て数字（0から9）で構成されているかを簡単に判定できます。例えば、「1234567890」はtrueと判定されますが、「Version-1.2.3」のような数字以外の文字が含まれる場合はfalseと判定されます。このようにwholeTextプロパティは、CDATAセクションのテキスト内容を取得し、その形式を検証する際に役立ちます。

Copy
1<?php
2
3/**
4 * Dom\CDATASection::wholeText プロパティの利用例を while(true) ループ内で示します。
5 *
6 * この関数は、while(true) ループを用いて、あるXMLコンテンツが継続的に処理されるシナリオをシミュレートします。
7 * 各イテレーションでXML文字列を解析し、その中に含まれる CDATA セクションから
8 * wholeText プロパティを使ってテキスト内容を正確に抽出する方法を示します。
9 * wholeText は、CDATAセクション内のマークアップ（例: <tags> や &entities;）を
10 * そのままのテキストとして取得するのに役立ちます。
11 */
12function processXmlWithCDataContinuously(): void
13{
14    echo "XMLコンテンツの継続的な処理をシミュレートします (Ctrl+C で停止).\n";
15
16    $iteration = 0;
17
18    // while(true) は無限ループを作成します。これは、バックグラウンドサービスや
19    // 継続的なデータ処理、ポーリングなどのシナリオでよく使用されます。
20    while (true) {
21        $iteration++;
22        echo "\n--- イテレーション {$iteration} ---\n";
23
24        // CDATAセクションを含むXMLコンテンツをシミュレートします。
25        // 実際のアプリケーションでは、これはファイルからの読み込み、API応答、
26        // データベースからの取得などによって動的に変化する可能性があります。
27        $xmlString = <<<XML
28<root>
29    <data>通常データです。</data>
30    <script_content>
31        <![CDATA[
32            function updateStatus(id) {
33                console.log("ID: " + id + " の処理を開始しました。");
34                // CDATAセクション内では、<tag>や&entity;のような文字は
35                // XMLマークアップとして解釈されずにそのままのテキストとして扱われます。
36                var status = "処理済み " + {$iteration} + " 回";
37                document.getElementById('status_' + id).innerText = status;
38            }
39        ]]>
40    </script_content>
41    <info>追加情報です。</info>
42</root>
43XML;
44
45        $dom = new Dom\Document();
46        // XML文字列をロードします。簡易化のため、エラーは抑制しています。
47        // 実際のアプリケーションでは、エラーハンドリング（例: try-catch、libxml_use_internal_errors）が推奨されます。
48        @$dom->loadXML($xmlString);
49
50        // DOMツリーをたどって、CDATAセクションを含む要素を検索します。
51        // ここでは '<script_content>' 要素の最初の子ノードが CDATA セクションであると仮定しています。
52        $cdataSection = null;
53        $scriptContentElement = $dom->getElementsByTagName('script_content')->item(0);
54
55        if ($scriptContentElement && $scriptContentElement->firstChild instanceof Dom\CDATASection) {
56            $cdataSection = $scriptContentElement->firstChild;
57        }
58
59        if ($cdataSection) {
60            // Dom\CDATASection::wholeText プロパティは、
61            // CDATAセクションが保持する全てのテキストコンテンツを文字列として返します。
62            // これにより、内部のXMLのような構造（例：HTMLタグや特殊文字）も
63            // そのままの形で取得できます。
64            $text = $cdataSection->wholeText;
65
66            echo "CDATAセクションが見つかりました。wholeTextで抽出された内容:\n";
67            echo "----------------------------------------\n";
68            echo $text . "\n";
69            echo "----------------------------------------\n";
70
71            // 実際のアプリケーションでは、この抽出されたテキストを
72            // ログに記録したり、実行したり（スクリプトの場合）、別の処理に渡したりします。
73        } else {
74            echo "現在のXMLコンテンツに CDATAセクションは見つかりませんでした。\n";
75        }
76
77        // 次のイテレーションに進む前に、作業や遅延をシミュレートします。
78        sleep(1); // 1秒間待機
79
80        // デモンストレーションのため、数回のイテレーション後にループを終了します。
81        // 実際の無限ループサービスでは、この 'if' ブロックは削除してください。
82        if ($iteration >= 3) {
83            echo "\n{$iteration}回のイテレーション後、シミュレートされた継続処理を完了しました。\n";
84            break;
85        }
86    }
87}
88
89// 関数を実行してデモンストレーションを開始します。
90processXmlWithCDataContinuously();
91
92?>

PHP 8のDom\CDATASection::wholeTextプロパティは、XMLドキュメント内で定義されたCDATAセクションが保持するテキストコンテンツを、そのままの形式で取得するために使用されます。このプロパティは引数を取らず、CDATAセクション内の全てのテキスト内容を文字列（string）として返します。

提供されたサンプルコードは、while(true)という無限ループを用いて、XMLコンテンツを継続的に処理するシステムをシミュレートしています。これは、常に最新のデータを監視したり、バックグラウンドで繰り返し特定の処理を実行したりするサービスで用いられる一般的な手法です。

各ループでは、CDATAセクションを含むXML文字列が用意され、DOMドキュメントとして読み込まれます。その後、script_content要素の子ノードとして存在するDom\CDATASectionオブジェクトを特定します。このDom\CDATASectionオブジェクトが見つかると、そのwholeTextプロパティにアクセスすることで、CDATAセクション内部に記述されたHTMLタグや特殊文字などの内容を、XMLの解析やエスケープ処理の影響を受けずに、完全に元のテキストとして抽出できます。これにより、CDATAセクション内のJavaScriptコードやマークアップが、XMLパーサーによって誤って解釈されることなく、安全にデータを取り扱うことが可能になります。このプロパティは、XML内に埋め込まれた特殊なテキストデータを正確に抽出・処理する際に役立ちます。