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

Copy
1<?php
2
3/**
4 * DOMCharacterData::substringData を使用して、DOMText ノードのデータ末尾から部分文字列を抽出します。
5 *
6 * この関数は、通常の文字列操作における「後ろからN文字」や「後ろからM文字目からN文字」といった
7 * 抽出を実現するために、DOMCharacterData のメソッドをどのように利用するかを示します。
8 *
9 * @param string $data 元となる文字列データ。DOMText ノードとして扱われます。
10 * @param int $startOffsetFromEnd 末尾から数えて、抽出を開始する位置のオフセット (1-based)。
11 *                                 例: 1を指定すると最後の文字から、5を指定すると末尾から5文字目から抽出します。
12 * @param int|null $length 抽出する文字数。null の場合、指定された開始位置から末尾まですべて抽出します。
13 * @return string 抽出された部分文字列。
14 * @throws InvalidArgumentException $startOffsetFromEnd がデータの長さより大きい場合、または0以下の場合。
15 */
16function extractSubstringFromDomTextEnd(
17    string $data,
18    int $startOffsetFromEnd,
19    ?int $length = null
20): string {
21    // DOMText ノードを作成するために DOMDocument が必要です。
22    $dom = new DOMDocument();
23    // 任意のテキストデータを保持する DOMText ノードを作成します。
24    $textNode = $dom->createTextNode($data);
25
26    // DOMCharacterData の length プロパティでデータの全長を取得します。
27    $dataLength = $textNode->length;
28
29    // $startOffsetFromEnd が不正な値でないか検証します。
30    if ($startOffsetFromEnd <= 0 || $startOffsetFromEnd > $dataLength) {
31        throw new InvalidArgumentException(
32            sprintf(
33                "末尾からの開始オフセット (%d) は、1からデータの全長 (%d) の範囲内である必要があります。",
34                $startOffsetFromEnd,
35                $dataLength
36            )
37        );
38    }
39
40    // DOMCharacterData::substringData は0-basedのオフセットを期待するため、変換します。
41    // 例: 全長10文字で末尾から3文字目 ('H' 'e' 'l' 'l' 'o' ' ' 'W' 'o' 'r' 'l' 'd')
42    //     末尾から3文字目 'l' の0-basedオフセットは 8 です。
43    //     計算: 10 - 3 = 7。 'l' は 'd' (0), 'l' (1), 'r' (2) なので 3文字目。 10 - 3 = 7. Oh, this needs to be 10 - $startOffsetFromEnd.
44    // Let's re-think:
45    // "Hello World" (length 11)
46    // If $startOffsetFromEnd = 1 (want 'd'), 0-based index is 10. `11 - 1 = 10`.
47    // If $startOffsetFromEnd = 3 (want 'r'), 0-based index is 8. `11 - 3 = 8`.
48    // This calculation `dataLength - $startOffsetFromEnd` seems correct for 0-based.
49    $offset = $dataLength - $startOffsetFromEnd;
50
51    // 抽出する文字数を設定します。
52    // null の場合、開始位置から残りのすべての文字を抽出します。
53    // DOMCharacterData::substringData は、指定されたカウントがデータの残りの長さよりも大きい場合、
54    // 残りのすべてを返すため、そのまま渡しても問題ありません。
55    $countToExtract = $length ?? $startOffsetFromEnd;
56
57    // DOMCharacterData::substringData メソッドを使用してデータを抽出します。
58    return $textNode->substringData($offset, $countToExtract);
59}
60
61// --- 使用例 ---
62
63$sampleText = "PHPはWeb開発に非常に強力な言語です。";
64
65echo "元の文字列: " . $sampleText . "\n\n";
66
67// 例1: 末尾から10文字を抽出
68// 「言語です。」が10文字
69try {
70    $lastTenChars = extractSubstringFromDomTextEnd($sampleText, 10);
71    echo "末尾から10文字: " . $lastTenChars . "\n";
72} catch (InvalidArgumentException $e) {
73    echo "エラー: " . $e->getMessage() . "\n";
74}
75
76// 例2: 末尾から15文字目から5文字を抽出
77// 「強力な言語です。」 (10文字) + 「非常に」 (4文字) = 14文字
78// 末尾から15文字目 = 「に」
79// 「に」から5文字 = 「に非常に」
80try {
81    $substringFromFifteenth = extractSubstringFromDomTextEnd($sampleText, 15, 5);
82    echo "末尾から15文字目から5文字: " . $substringFromFifteenth . "\n";
83} catch (InvalidArgumentException $e) {
84    echo "エラー: " . $e->getMessage() . "\n";
85}
86
87// 例3: 末尾から5文字目から残りのすべての文字を抽出
88// 「言語です。」
89try {
90    $fromFifthToEnd = extractSubstringFromDomTextEnd($sampleText, 5);
91    echo "末尾から5文字目から最後まで: " . $fromFifthToEnd . "\n";
92} catch (InvalidArgumentException $e) {
93    echo "エラー: " . $e->getMessage() . "\n";
94}
95
96// 例4: 不正な開始オフセットの例 (データの長さを超える)
97try {
98    // データの長さは約20文字程度。100は明らかに大きい。
99    $invalidOffset = extractSubstringFromDomTextEnd($sampleText, 100);
100    echo "不正な抽出 (長すぎるオフセット): " . $invalidOffset . "\n";
101} catch (InvalidArgumentException $e) {
102    echo "エラー (長すぎるオフセット): " . $e->getMessage() . "\n";
103}
104
105// 例5: 不正な開始オフセットの例 (0以下)
106try {
107    $invalidOffsetZero = extractSubstringFromDomTextEnd($sampleText, 0);
108    echo "不正な抽出 (0以下のオフセット): " . $invalidOffsetZero . "\n";
109} catch (InvalidArgumentException $e) {
110    echo "エラー (0以下のオフセット): " . $e->getMessage() . "\n";
111}

PHP 8のDOMCharacterData::substringDataメソッドは、DOM（Document Object Model）拡張機能の一部で、DOMTextやDOMCommentのような文字データを持つノードから、部分文字列を抽出するために使用されます。

このメソッドは、2つの整数型の引数を取ります。最初の引数$offsetは、文字列の先頭から数えて（0始まりで）抽出を開始する位置を指定します。次の引数$countは、指定された$offsetから何文字抽出するかを指定します。戻り値は、抽出された部分文字列をstring型で返します。指定された$countが残りの文字数より大きい場合でも、エラーにならず、開始位置から残りのすべての文字が返される挙動となります。

提供されたサンプルコードは、このDOMCharacterData::substringDataメソッドを利用し、通常の文字列操作でよく使われる「文字列の末尾から部分文字列を抽出する」機能を実現しています。具体的には、入力された文字列を一時的にDOMTextノードとして作成し、文字列全体の長さから「末尾からの位置」を「先頭からの0始まりの位置」に変換します。これにより、「末尾から10文字」や「末尾から15文字目から5文字」のように、文字列の末尾を基準とした部分文字列の抽出が可能です。この方法は、PHPの組み込み文字列関数とは異なり、DOMノードが保持するテキストデータを操作する際に特に有効です。

Copy
1<?php
2
3// DOMCharacterData::substringData メソッドの利用例
4// DOMCharacterData はインターフェースであり、DOMText などのクラスがこれを実装します。
5// このメソッドは、DOMノード内の文字列データの一部を抽出するために使用されます。
6
7// 1. DOMDocument オブジェクトを作成します。
8$dom = new DOMDocument('1.0', 'UTF-8');
9
10// 2. テキストノードを作成します。DOMCharacterData インターフェースを実装しています。
11$originalText = 'Hello, PHP DOM CharacterData Example!';
12$textNode = $dom->createTextNode($originalText);
13
14// 3. テキストノードを文書に追加します（ここではルート要素の子として追加）。
15// DOMCharacterData を直接操作するためには、それがDOMツリーの一部である必要はありませんが、
16// 一般的な使用シナリオを示すために追加します。
17$element = $dom->createElement('data');
18$element->appendChild($textNode);
19$dom->appendChild($element);
20
21echo "元のテキスト: " . $textNode->nodeValue . PHP_EOL;
22
23// 4. substringData メソッドを使用して、文字列データの一部を抽出します。
24// 引数:
25//   $offset (int): 抽出を開始する位置 (0-basedインデックス)。
26//   $count (int): 抽出する文字数。
27
28// 例1: 最初の5文字を抽出 ('Hello')
29$offset1 = 0;
30$count1 = 5;
31$substring1 = $textNode->substringData($offset1, $count1);
32echo "substringData(0, 5) => " . $substring1 . PHP_EOL;
33
34// 例2: インデックス 7 から 3 文字を抽出 ('PHP')
35$offset2 = 7;
36$count2 = 3;
37$substring2 = $textNode->substringData($offset2, $count2);
38echo "substringData(7, 3) => " . $substring2 . PHP_EOL;
39
40// 例3: インデックス 11 から残りのすべての文字を抽出 ('DOM CharacterData Example!')
41// $count には十分大きな値を指定するか、文字列の長さを利用します。
42$offset3 = 11;
43$count3 = strlen($originalText) - $offset3; // 残りのすべての文字数
44// あるいは、非常に大きな数（例: 1000）を指定しても、自動的に文字列の最後までが抽出されます。
45// $count3 = 1000;
46$substring3 = $textNode->substringData($offset3, $count3);
47echo "substringData(11, " . $count3 . ") => " . $substring3 . PHP_EOL;
48
49?>

PHP 8のDOMCharacterData::substringDataメソッドは、XMLやHTMLなどのDOM（Document Object Model）ツリー内で扱う文字列データの一部を抽出するために利用されます。DOMCharacterDataはテキストノードなど、文字データを保持するノードの共通インターフェースであり、DOMTextのようなクラスがこれを実装しています。

このメソッドは二つの整数型の引数を取ります。最初の$offsetは、文字列データの抽出を開始する位置を0を基点としたインデックスで指定します。次の$countは、$offsetで指定された位置から何文字分のデータを抽出するかを指定します。戻り値は、指定された範囲で抽出された部分文字列です。

サンプルコードでは、まずDOMTextオブジェクトを作成し、元のテキストデータを設定しています。そして、このテキストノードに対してsubstringDataメソッドを呼び出しています。例えば、substringData(0, 5)と指定すると、文字列の先頭から5文字の「Hello」が抽出されます。また、substringData(7, 3)では、インデックス7の位置から3文字分の「PHP」が抽出されます。$countに非常に大きな値を指定した場合や、残りのすべての文字数を指定した場合は、$offset以降の文字列の最後までが抽出されます。このメソッドは、DOM内の特定のテキスト部分を柔軟に取得・操作する際に役立ちます。