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

Copy
1<?php
2
3/**
4 * Dom\CDATASection::substringData メソッドを使用して、
5 * CDATAセクションの内容の末尾から指定された長さの文字列を抽出します。
6 *
7 * システムエンジニアを目指す初心者向けに、DOM操作と文字列の末尾からの抽出ロジックを解説します。
8 *
9 * @param string $cdataContent CDATAセクションとして扱う元の文字列データ。
10 * @param int    $lengthFromEnd 末尾から取得したい文字数。
11 *                               この値が元の文字列長を超える場合、文字列全体が返されます。
12 * @return string 抽出された部分文字列。
13 */
14function getSubstringFromEndOfCdata(string $cdataContent, int $lengthFromEnd): string
15{
16    // 1. DOMDocument を作成し、XMLドキュメントの基本構造を準備します。
17    //    DOMDocument は、XML ドキュメント全体を表現するオブジェクトです。
18    //    '1.0' はXMLのバージョン、'UTF-8' は文字エンコーディングです。
19    $dom = new DOMDocument('1.0', 'UTF-8');
20
21    // 2. ルート要素を作成し、DOMDocumentに追加します。
22    //    CDATASection は通常、XML要素の子ノードとして存在するため、
23    //    仮の親要素 'root' を作成します。
24    $rootElement = $dom->createElement('root');
25    $dom->appendChild($rootElement);
26
27    // 3. 指定された文字列データから DOMCDATASection オブジェクトを作成します。
28    //    DOMCDATASection は、XMLドキュメント内で特殊な文字をエスケープせずに含めるためのノードです。
29    //    リファレンスにある Dom\CDATASection は、PHP 8で導入された名前空間付きクラスですが、
30    //    互換性のためにグローバルエイリアスである DOMCDATASection も引き続き利用できます。
31    $cdataNode = $dom->createCDATASection($cdataContent);
32
33    // 4. 作成した CDATA セクションノードをルート要素に追加します。
34    $rootElement->appendChild($cdataNode);
35
36    // 5. CDATAセクションの全体の長さを取得します。
37    //    DOMCharacterData::length プロパティは、ノードに含まれる文字列データの長さを返します。
38    $totalLength = $cdataNode->length;
39
40    // 6. 末尾から $lengthFromEnd 文字を取得するための開始オフセットを計算します。
41    //    例: 全長が10文字で、末尾から3文字取得する場合、オフセットは 10 - 3 = 7 となります。
42    //    max(0, ...) を使用して、オフセットが負にならないように保証します。
43    //    $lengthFromEnd が $totalLength を超える場合、オフセットは0（先頭）になります。
44    $offset = max(0, $totalLength - $lengthFromEnd);
45
46    // 7. substringData メソッドで実際に取得する文字数を計算します。
47    //    開始オフセットから文字列の末尾までの文字数 ($totalLength - $offset) となります。
48    //    これにより、$lengthFromEnd が元の文字列長を超えても、
49    //    `substringData` が有効な範囲で動作し、文字列全体が適切に返されます。
50    $count = $totalLength - $offset;
51
52    // 8. Dom\CDATASection::substringData メソッドを呼び出し、部分文字列を抽出します。
53    //    第1引数: 抽出を開始する0ベースのオフセット。
54    //    第2引数: 抽出する文字数。
55    $extractedString = $cdataNode->substringData($offset, $count);
56
57    return $extractedString;
58}
59
60// --- サンプルコードの利用例 ---
61
62// 元のCDATAセクションデータ
63$originalData = "これはCDATAセクションのテストデータです。末尾からN文字を取得する例。";
64
65echo "元のデータ: " . $originalData . PHP_EOL;
66echo "------------------------------------" . PHP_EOL;
67
68// 例1: 末尾から10文字を取得
69$lengthToExtract1 = 10;
70$result1 = getSubstringFromEndOfCdata($originalData, $lengthToExtract1);
71echo "末尾から " . $lengthToExtract1 . " 文字: '" . $result1 . "'" . PHP_EOL;
72echo "------------------------------------" . PHP_EOL;
73
74// 例2: 末尾から5文字を取得
75$lengthToExtract2 = 5;
76$result2 = getSubstringFromEndOfCdata($originalData, $lengthToExtract2);
77echo "末尾から " . $lengthToExtract2 . " 文字: '" . $result2 . "'" . PHP_EOL;
78echo "------------------------------------" . PHP_EOL;
79
80// 例3: 末尾から元の文字列長よりも長い文字数を指定した場合（文字列全体が返されます）
81$lengthToExtract3 = 100; // 元の文字列長は上記データでおよそ50文字程度
82$result3 = getSubstringFromEndOfCdata($originalData, $lengthToExtract3);
83echo "末尾から " . $lengthToExtract3 . " 文字: '" . $result3 . "'" . PHP_EOL;
84echo "------------------------------------" . PHP_EOL;
85
86// 例4: 末尾から0文字を指定した場合（空文字列が返されます）
87$lengthToExtract4 = 0;
88$result4 = getSubstringFromEndOfCdata($originalData, $lengthToExtract4);
89echo "末尾から " . $lengthToExtract4 . " 文字: '" . $result4 . "'" . PHP_EOL;
90
91?>

このサンプルコードは、PHPのDOM拡張機能に含まれるDom\CDATASection::substringDataメソッドを利用し、XMLドキュメント内のCDATAセクションの内容から末尾の指定された長さの文字列を抽出する方法を解説しています。Dom\CDATASectionクラスは、XMLドキュメントにおいて特殊な文字をエスケープせずにテキストデータを含めるためのCDATAセクションノードを操作する際に用いられます。

substringDataメソッドは、CDATAセクションノードが持つ文字列データに対し、第1引数$offsetで指定された開始位置（0から始まる）から、第2引数$countで指定された文字数だけ部分文字列を抽出します。抽出された文字列が戻り値として返されます。このメソッド自体は直接「後ろから」の抽出機能を持っていませんが、サンプルコードでは文字列の全長を活用して、末尾からの抽出ロジックを実現しています。

具体的には、まずDOMDocumentオブジェクトと、与えられた文字列データからDOMCDATASectionノードを作成し、XML構造内に組み込みます。次に、DOMCDATASectionノードの全体の文字数を取得します。この全長と、末尾から取得したい文字数$lengthFromEndを使って、substringDataメソッドに渡す開始オフセットと実際に抽出する文字数を計算します。オフセットは負の値にならないよう、また抽出文字数は元の文字列の範囲を超えないように調整されており、これにより$lengthFromEndが元の文字列長より大きい場合でも文字列全体が適切に抽出されます。最後に、計算されたオフセットと文字数を用いてsubstringDataメソッドを呼び出し、目的の部分文字列を取得して返しています。この一連の処理により、CDATAセクション内のデータから末尾の任意の長さの文字列を正確に抽出することが可能となります。

Copy
1<?php
2
3// DOMDocumentは、XMLドキュメント全体を表現するクラスです。
4// ここでは、XMLバージョン1.0、UTF-8エンコーディングで新しいドキュメントを作成しています。
5$dom = new DOMDocument('1.0', 'UTF-8');
6
7// CDATAセクションに含める元の文字列を準備します。
8// CDATAセクションは、XMLパーサによって解析されないテキストブロックです。
9// これにより、`<`や`>`のようなXMLの特殊文字を含むテキストも安全にXML内に格納できます。
10$originalCdataContent = 'This is some <important> XML data with special characters like & and <.> symbols.';
11
12// DOMDocumentのcreateCDATASection() メソッドを使用して、CDATAセクションノードを作成します。
13// この時点では、まだドキュメントツリーには追加されていません。
14$cdataSection = $dom->createCDATASection($originalCdataContent);
15
16// Dom\CDATASection::substringData() メソッドは、
17// CDATAセクション内のテキストデータから指定された範囲の部分文字列を抽出します。
18//
19// 構文: string substringData(int $offset, int $count)
20//   $offset: 抽出を開始する位置（0から数えます）。
21//   $count: 抽出する文字数。
22
23// 例1: オフセット5（6文字目）から10文字を抽出します。
24// 元の文字列: "This is some <important> XML data..."
25//             "     ^          "
26//             "     i s   s o m e   < i m p"
27$offset1 = 5;
28$count1 = 10;
29$extractedSubstring1 = $cdataSection->substringData($offset1, $count1);
30
31// 抽出された部分文字列と、元のCDATAコンテンツを表示します。
32echo "元のCDATAコンテンツ: " . $cdataSection->data . PHP_EOL;
33echo "例1: オフセット {$offset1} から {$count1} 文字抽出した結果: '{$extractedSubstring1}'" . PHP_EOL;
34
35// 例2: オフセット0（最初の文字）から7文字を抽出します。
36// 元の文字列: "This is some <important> XML data..."
37//             "^^^^^^^"
38//             "This is"
39$offset2 = 0;
40$count2 = 7;
41$extractedSubstring2 = $cdataSection->substringData($offset2, $count2);
42echo "例2: オフセット {$offset2} から {$count2} 文字抽出した結果: '{$extractedSubstring2}'" . PHP_EOL;
43
44// 注意点:
45// - $offset が元の文字列の長さを超える場合、空文字列が返されます。
46// - $count が $offset からの残り文字数を超える場合、残りのすべての文字が返されます。

Dom\CDATASection::substringDataメソッドは、PHPでXMLドキュメントを扱う際に、CDATAセクション内のテキストデータから指定した範囲の部分文字列を抽出するメソッドです。

サンプルコードでは、まずDOMDocumentクラスを使ってXMLドキュメントを作成し、createCDATASection()メソッドでCDATAセクションノードを生成しています。CDATAセクションは、<や>などのXML特殊文字をエスケープせずにテキストを格納できるため、XMLパーサに内容を解釈させたくない場合に利用されます。

substringData()メソッドは、int $offsetとint $countの二つの引数を受け取ります。$offsetは部分文字列の抽出を開始する位置を0から数えて指定し、$countはその位置から抽出する文字数を指定します。メソッドの戻り値は、抽出されたstring型の部分文字列です。

例1では、CDATAセクション内のテキスト「This is some <important> XML data...」から、オフセット5（6文字目）から10文字を抽出し、「is some <i」という部分文字列を取得しています。例2では、オフセット0（最初の文字）から7文字を抽出し、「This is」という部分文字列を取得しています。

また、$offsetが元の文字列の長さを超える場合は空文字列が返され、$countが$offsetからの残り文字数を超える場合は、残りのすべての文字が抽出されて返される点にも注意が必要です。