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

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

作成日: 更新日:

基本的な使い方

『__toStringメソッドは、InvalidArgumentExceptionオブジェクトの文字列表現を生成し、それを返す処理を実行するメソッドです』 このメソッドは、オブジェクトが文字列として扱われる文脈、例えばecho文で出力しようとしたり、文字列へのキャストが行われたりした場合に自動的に呼び出されます。返される文字列には、例外に関する包括的な情報が含まれており、デバッグ作業に非常に役立ちます。具体的には、例外のクラス名、コンストラクタで設定されたエラーメッセージ、例外がスローされたファイル名と行番号、そして例外が発生するまでの関数呼び出しの履歴を示すスタックトレースが、整形された形式で結合されたものが返されます。これにより、開発者はcatchした例外オブジェクトをそのままログに出力するだけで、エラーの原因を特定するための詳細な情報を簡単に得ることができます。この振る舞いは、親クラスであるExceptionクラスで定義されており、InvalidArgumentExceptionクラスはそれを継承して利用しています。

構文(syntax)

1$exception = new InvalidArgumentException("エラーメッセージ", 123);
2
3// 例外オブジェクトを文字列として扱うと __toString() が自動的に呼び出される
4echo $exception;

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このメソッドは、例外オブジェクトを文字列として表現したものを返します。これは、例外のメッセージやファイル名、行番号などの情報を含みます。

関連コンテンツ