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

__toStringメソッドは、UnderflowExceptionオブジェクトが持つ情報を、人間が読める文字列形式に変換して返す処理を実行するメソッドです。このメソッドは開発者が直接呼び出すことは少なく、オブジェクトが文字列として扱われる状況でPHPによって自動的に呼び出されます。例えば、echo構文で例外オブジェクトを出力しようとした場合や、ログファイルに例外情報を書き出す際に内部的に使用されます。このメソッドが返す文字列には、デバッグ作業に非常に役立つ情報が含まれており、具体的には例外のクラス名、コンストラクタで設定されたエラーメッセージ、例外がスローされたファイル名と行番号、そして例外発生地点までの関数の呼び出し履歴を示すスタックトレースが整形された形で含まれます。この動作は、PHPの全ての例外クラスの親であるExceptionクラスで定義されている機能であり、UnderflowExceptionクラスはそれを継承することで、例外の詳細を簡単に文字列として取得できるようになっています。

Copy
1<?php
2
3try {
4    throw new UnderflowException("This is an UnderflowException example.");
5} catch (UnderflowException $e) {
6    // UnderflowException::__toString() の構文
7    $exceptionAsString = $e->__toString();
8    echo $exceptionAsString;
9}
10
11?>

引数なし

引数はありません

string

このメソッドは、例外オブジェクトを文字列として表現したものを返します。