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

substringDataメソッドは、PHPのDOM拡張機能において、DOMCharacterDataクラスに属するメソッドです。このメソッドは、XMLやHTMLドキュメント内でテキストデータを扱う際に、特定のテキストノードやコメントノードなどが保持する文字列から、指定した範囲の部分文字列を抽出するために使用されます。

具体的には、文字列のどの位置から（オフセット）、どれだけの文字数分（カウント）を抽出するかを指定して呼び出します。オフセットは文字列の先頭を0として数え、カウントは抽出したい文字の長さを指定します。例えば、あるテキストノードが「Hello World」という文字列を持っている場合、substringData(6, 5)と指定すると、「World」という部分文字列が返されます。

指定されたオフセットが文字列の長さを超える場合や、カウントに負の値が指定されるなど、無効な引数が与えられた場合には、DOMExceptionが発生する可能性がありますので、引数の指定には注意が必要です。しかし、カウントで指定された長さが、オフセットから文字列の最後まで残っている文字数よりも大きい場合でも、エラーにはならず、残りのすべての文字が返されます。これにより、DOMツリー内のテキストデータをプログラムで柔軟に操作し、必要な部分だけを取り出すことが可能になります。システムエンジニアを目指す方々にとって、ウェブページのコンテンツを解析したり、動的に変更したりする際に、このメソッドはテキストデータの効率的な取り扱いにおいて重要な役割を果たします。

Copy
1<?php
2
3$document = new DOMDocument();
4$characterDataNode = $document->createTextNode("Hello, world!");
5$characterDataNode->substringData(7, 5);
6
7?>

int $offset, int $count

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

string

指定されたオフセットから始まる、指定された長さの文字列を返します。