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

__toStringメソッドは、LengthExceptionオブジェクトが持つ情報を、人間が読みやすい文字列形式で取得するために実行するメソッドです。このメソッドは、例外に関する詳細な情報を整形された一つの文字列として返す役割を担います。返される文字列には、例外のクラス名である「LengthException」、コンストラクタで設定されたエラーメッセージ、例外がスローされたファイル名と行番号、そしてそこに至るまでの関数の呼び出し履歴を示すスタックトレースといった、デバッグに不可欠な情報が網羅的に含まれます。このメソッドはPHPのマジックメソッドの一つであり、オブジェクトを文字列として扱おうとする文脈、例えばechoで例外オブジェクトを出力しようとした場合や、文字列と連結しようとした場合に自動的に呼び出されます。そのため、try-catchブロックで捕捉した例外オブジェクトの内容をログに記録したり、開発中にエラー内容を画面に表示したりする際に非常に便利で、エラーの原因を効率的に特定する手助けとなります。

Copy
1<?php
2try {
3    throw new LengthException("長さが無効です。");
4} catch (LengthException $e) {
5    // 例外オブジェクトを文字列として評価すると __toString() が呼び出される
6    echo $e;
7}
8?>

引数なし

引数はありません

string

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