【PHP8.x】substringDataメソッドの使い方

substringDataメソッドは、DOMTextノードから指定された範囲の文字列を抽出するメソッドです。DOMTextは、XMLドキュメントまたはHTMLドキュメント内のテキストコンテンツを表すノードです。このメソッドを使用すると、ノードに格納されているテキストの一部を、開始位置と長さを指定して取得できます。

このメソッドは、2つの引数を取ります。1つ目は$offsetで、抽出を開始する文字の位置（オフセット）を整数値で指定します。オフセットは0から始まるインデックスで、最初の文字は0の位置にあります。2つ目の引数は$countで、抽出する文字数を整数値で指定します。

$offsetがテキストの長さよりも大きい場合、または$countが0より小さい場合は、例外が発生します。$offsetと$countの合計がテキストの長さよりも大きい場合、$offsetからテキストの最後までが抽出されます。

substringDataメソッドは、抽出された文字列を返します。元のDOMTextノードの内容は変更されません。このメソッドは、テキストノードから特定の情報を抽出したり、大きなテキストノードを処理する際に便利です。例えば、長いテキストを分割して表示したり、特定の部分を強調表示したりする際に利用できます。

Copy
1DOMText::substringData(int $offset, int $count): string

int $offset, int $count

• int $offset: 抽出を開始するオフセット（位置）を指定する整数。0から始まります。
• int $count: 抽出する文字数を指定する整数。

string

指定された位置から文字列の一部を抽出して返します。