【PHP8.x】Dom\ProcessingInstruction::substringData()メソッドの使い方
substringDataメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
『substringDataメソッドは、Dom\ProcessingInstructionオブジェクトが持つデータの中から、指定した一部分を文字列として取り出す処理を実行するメソッドです。処理命令（Processing Instruction）とは、XMLやHTML文書内で<?target data?>のように記述される特別な命令を指します。このメソッドが操作するのは、この中のdataにあたる文字列部分です。メソッドには2つの数値を引数として渡します。第1引数offsetは、文字列の切り出しを開始する位置を指定するもので、先頭の文字を0として数えます。第2引数countは、offsetの位置から何文字分を切り出すかを指定します。このメソッドを呼び出すと、指定された範囲の文字列が返り値として得られます。もしoffsetとcountで指定した範囲がデータの末尾を超えてしまう場合でもエラーにはならず、offsetの位置からデータの最後までを切り出した文字列が返されます。ただし、offsetに負の数や、文字列の長さを超える数値を指定した場合はDom\DOMExceptionという例外が発生するため、適切な値の指定が必要です。』
構文(syntax)
1public function substringData(int $offset, int $count): string|false;
引数(parameters)
int $offset, int $count
- int $offset: 取得を開始する文字位置を指定する整数。0から始まります。
- int $count: 取得する文字数を指定する整数。
戻り値(return)
string|false
指定されたオフセットから始まる、指定された長さのノードの文字列表現を返します。指定されたオフセットまたは長さが無効な場合はfalseを返します。