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

substringDataメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

『substringDataメソッドは、Dom\Textオブジェクトが持つテキストデータから、指定した部分文字列を取得するために実行するメソッドです。このメソッドは、元のテキストノードの内容を一切変更せずに、その一部分を文字列として取り出します。メソッドを呼び出す際には2つの引数を指定する必要があります。第1引数には、切り出しを開始したい位置を0から始まる数値(オフセット)で指定します。第2引数には、開始位置から何文字分を切り出すかの長さ(文字数)を指定します。処理が正常に完了した場合、戻り値として切り出された文字列が返されます。もし、指定した開始位置がテキストデータの長さを超えているなど、無効な範囲が指定された場合には、文字列の代わりにfalseが返されます。これにより、プログラムは文字列の取得が成功したかどうかを判断できます。HTMLやXMLドキュメント内の特定のテキスト情報の一部だけを安全に読み取りたい場合に非常に便利なメソッドです。』

構文(syntax)

1<?php
2
3$dom = new Dom\Document();
4$dom->loadHTML('<div>Hello World</div>');
5
6// 'Hello World' というテキストノードを取得
7$textNode = $dom->getElementsByTagName('div')->item(0)->firstChild;
8
9// public function substringData(int $offset, int $length): string
10$substring = $textNode->substringData(6, 5);
11
12// 出力: "World"
13echo $substring;
14
15?>

引数(parameters)

int $offset, int $length

  • int $offset: 取得を開始する位置を指定する整数
  • int $length: 取得する文字数を指定する整数

戻り値(return)

string

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

関連コンテンツ

関連プログラミング言語