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

Copy
1<?php
2
3/**
4 * DOMCdataSection::substringData を使用して、CDATAセクションの内容から
5 * 特定の部分文字列を取得するサンプルコードです。
6 * キーワード「後ろから」に対応するため、文字列の長さを利用してオフセットを計算します。
7 */
8
9// 1. DOMDocument オブジェクトを作成します。
10//    これによりXMLドキュメントの構造を操作できるようになります。
11$dom = new DOMDocument('1.0', 'UTF-8');
12$dom->formatOutput = true; // 出力を整形します
13
14// 2. ルート要素を作成し、DOMドキュメントに追加します。
15$root = $dom->createElement('data');
16$dom->appendChild($root);
17
18// 3. CDATAセクションの文字列データを作成します。
19$cdataContent = "これはXMLのCDATAセクション内のサンプルデータです。文字列を後ろから取得してみましょう。";
20
21// 4. DOMCdataSection オブジェクトを作成し、ルート要素に追加します。
22//    CDATAセクションは、XMLパーサに内容を文字データとして解釈させます。
23$cdataSection = $dom->createCDATASection($cdataContent);
24$root->appendChild($cdataSection);
25
26echo "--- 元のCDATAセクションの内容 ---\n";
27echo $cdataSection->data . "\n\n";
28
29// 5. DOMCdataSection::substringData を使用して部分文字列を抽出します。
30//    このメソッドは DOMCharacterData クラスから継承されています。
31//    引数は (int $offset, int $count) で、文字列の先頭からのオフセットと取得する文字数です。
32//    PHPの文字列操作関数の多くはバイト数を扱うため、マルチバイト文字列の場合は mb_xxx 関数を使用しますが、
33//    DOMのsubstringDataは文字数を扱うため、mb_strlen で文字数を取得してオフセット計算を行います。
34
35// CDATAセクションデータの実際の文字数を取得します。
36$dataLength = mb_strlen($cdataSection->data, 'UTF-8');
37
38// 例1: 後ろから特定の文字数分を取得する
39$count1 = 9; // 取得したい文字数
40// オフセットを計算します: 全体の長さ - 取得したい文字数
41$offset1 = $dataLength - $count1;
42
43// substringData メソッドを呼び出して部分文字列を取得します。
44$result1 = $cdataSection->substringData($offset1, $count1);
45
46echo "--- 後ろから {$count1} 文字を取得 ---\n";
47echo "元の長さ: {$dataLength} 文字\n";
48echo "計算されたオフセット: {$offset1}\n";
49echo "取得結果: \"{$result1}\"\n\n"; // 期待値: 「てみましょう。」
50
51// 例2: 後ろから数えて特定の開始位置から、特定の文字数分を取得する
52$count2 = 7; // 取得したい文字数
53$offsetFromEnd2 = 14; // 後ろから数えて、取得を開始する位置（例: 「から取得」の「か」）
54// オフセットを計算します: 全体の長さ - (後ろからの開始位置 + 取得したい文字数)
55$offset2 = $dataLength - ($offsetFromEnd2 + $count2);
56
57$result2 = $cdataSection->substringData($offset2, $count2);
58
59echo "--- 後ろから {$offsetFromEnd2} 文字目から {$count2} 文字を取得 ---\n";
60echo "元の長さ: {$dataLength} 文字\n";
61echo "計算されたオフセット: {$offset2}\n";
62echo "取得結果: \"{$result2}\"\n\n"; // 期待値: 「ろから取得」
63
64?>

PHP 8のDOMCdataSection::substringDataメソッドは、XMLドキュメント内で定義されたCDATAセクションの内容から、指定された範囲の部分文字列を抽出するために使用されます。このメソッドは、DOMCdataSectionオブジェクトが内部に保持する文字列データに対して機能します。

メソッドの引数として、int $offsetは部分文字列の取得を開始する位置を、文字列の先頭から数えたオフセット（0から始まります）として指定します。int $countは、その開始位置から何文字分取得するかを指定します。そして、戻り値としては抽出された部分文字列がstring型で返されます。

特に「文字列を後ろから取得したい」という要件がある場合、$offsetが常に先頭からの位置であるため、元の文字列の全長を利用して開始位置を計算する必要があります。日本語のようなマルチバイト文字を含む文字列を扱う場合、PHPの標準的な文字列関数ではバイト数で計算されることが多いですが、DOMCdataSection::substringDataは文字数で処理を行います。そのため、正確な文字数を取得するためにmb_strlen関数を使用することが重要です。

例えば、文字列全体の長さをlengthとした場合、後ろからN文字を取得するにはlength - Nを$offsetに指定します。また、後ろから数えてM文字目からN文字を取得したい場合は、length - (M + N)という計算式で$offsetを決定します。このように、substringDataメソッドは、オフセットの計算方法を工夫することで、文字列の任意の位置から柔軟に部分文字列を抽出することが可能です。

Copy
1<?php
2
3/**
4 * DOMCdataSection::substringData メソッドの利用例を示す関数です。
5 * このメソッドは、XMLのCDATAセクションノードから指定された範囲の文字列を取得します。
6 *
7 * システムエンジニアを目指す初心者の方向けに、PHPのDOM拡張機能における
8 * CDATAセクションの扱いと、その部分文字列取得方法を具体的に示します。
9 */
10function demonstrateCdataSubstringData(): void
11{
12    // 1. 新しいDOMDocumentオブジェクトを作成します。
13    //    XMLバージョン1.0、エンコーディングUTF-8を指定します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    // 出力XMLを見やすく整形するための設定です。
16    $dom->formatOutput = true;
17
18    // 2. ルート要素 '<root>' を作成し、DOMツリーに追加します。
19    $root = $dom->createElement('root');
20    $dom->appendChild($root);
21
22    // 3. CDATAセクションに含めるテキストデータを用意します。
23    //    CDATAセクション内のテキストは、XMLパーサによって解析されずにそのまま扱われます。
24    //    これにより、XMLで予約されている文字（<, >, &, ',"など）をエスケープなしで記述できます。
25    $cdataContent = "これはCDATAセクションのサンプルデータです。特殊文字 < & > もそのまま扱われます。";
26
27    // 4. DOMCdataSectionノードを作成します。
28    //    DOMCdataSectionクラスはDOMTextクラスを継承しており、テキストデータを扱います。
29    $cdataNode = $dom->createCDATASection($cdataContent);
30
31    // 5. 作成したCDATAセクションノードをルート要素の子として追加します。
32    $root->appendChild($cdataNode);
33
34    echo "--- 元のCDATAセクションデータ ---" . PHP_EOL;
35    echo "内容: " . $cdataNode->data . PHP_EOL;
36    // `data`プロパティはDOMCdataSectionノードのテキスト内容を表します。
37    // マルチバイト文字も1文字としてカウントされるため、`mb_strlen`で確認できます。
38    echo "長さ: " . mb_strlen($cdataNode->data, 'UTF-8') . " 文字" . PHP_EOL . PHP_EOL;
39
40    // 6. DOMCdataSection::substringData メソッドを使用して部分文字列を取得します。
41    //    引数:
42    //      $offset (int): 開始位置 (0から始まるインデックス)
43    //      $count (int): 取得する文字数
44    //    このメソッドは、指定されたオフセットから指定された文字数分の部分文字列を返します。
45    //    PHPの一般的な文字列関数とは異なり、DOMの文脈では文字単位でオフセットとカウントが指定されます。
46
47    // 例1: 先頭 (オフセット0) から最初の10文字を取得します。
48    $substring1 = $cdataNode->substringData(0, 10);
49    echo "--- substringData(0, 10) の結果 ---" . PHP_EOL;
50    echo "開始位置 0、文字数 10: " . $substring1 . PHP_EOL . PHP_EOL; // 期待値: "これはCDATAセ"
51
52    // 例2: オフセット7 (8文字目) から15文字を取得します。
53    $substring2 = $cdataNode->substringData(7, 15);
54    echo "--- substringData(7, 15) の結果 ---" . PHP_EOL;
55    echo "開始位置 7、文字数 15: " . $substring2 . PHP_EOL . PHP_EOL; // 期待値: "DAセクションのサンプル"
56
57    // 例3: 指定されたオフセットから、残りの全ての文字を取得します。
58    //      $count にデータ長を超える大きな値を指定すると、末尾まで全ての文字が返されます。
59    $offsetForRemaining = 20;
60    $substring3 = $cdataNode->substringData($offsetForRemaining, 9999); // 9999は十分大きな値
61    echo "--- substringData(" . $offsetForRemaining . ", 9999) の結果 ---" . PHP_EOL;
62    echo "開始位置 " . $offsetForRemaining . "、残り全て: " . $substring3 . PHP_EOL . PHP_EOL;
63    // 期待値: "ンプルデータです。特殊文字 < & > もそのまま扱われます。"
64
65    // (参考) 生成されたXMLの表示 (コメントアウトされていますが、必要に応じて有効にしてください)
66    // echo "--- 生成されたXML ---" . PHP_EOL;
67    // echo $dom->saveXML() . PHP_EOL;
68}
69
70// 関数を実行して、DOMCdataSection::substringDataの動作を確認します。
71demonstrateCdataSubstringData();
72

PHPのDOMCdataSection::substringDataメソッドは、XMLドキュメント内のCDATAセクションノードから、指定された範囲の部分文字列を取得するために使用されます。CDATAセクションとは、XMLパーサに内容を解析させず、特殊文字（<や&など）をエスケープせずにそのままテキストとして扱わせるための、XMLの特別なブロックです。

このsubstringDataメソッドは、二つの整数型の引数を受け取ります。一つ目の$offsetは、文字列の取得を開始する位置を0から始まるインデックスで指定します。二つ目の$countは、$offsetで指定された位置から何文字分の文字列を取得するかを指定します。メソッドは、これらの指定に基づいて切り出された部分文字列をstring型で返します。例えば、substringData(0, 10)と指定すると、CDATAセクションの先頭から10文字が取得されます。また、$countにデータの実際の長さよりも大きな値を指定した場合でもエラーとはならず、指定された$offsetから文字列の末尾まで全ての文字が返されます。

サンプルコードでは、まず新しいDOMDocumentオブジェクトを作成し、その中にCDATAセクションを含むXML構造を構築しています。そして、作成されたDOMCdataSectionノードに対してsubstringDataメソッドを異なる引数で複数回呼び出し、実際にどのように部分文字列が取得されるかを示しています。このメソッドは、XMLドキュメントから特定のテキスト情報をプログラムで抽出し処理する際に役立ちます。