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

__toStringメソッドは、DomainExceptionオブジェクトが文字列として扱われた際に、そのオブジェクトを表現する文字列を生成して返す処理を実行するメソッドです。このメソッドは、PHPの基底クラスであるExceptionクラスで定義されており、DomainExceptionクラスはこれを継承しています。そのため、他の多くの例外クラスでも同様の動作をします。返される文字列には、例外のクラス名、コンストラクタで設定されたエラーメッセージ、例外がスローされたファイル名と行番号、そして例外発生地点に至るまでの関数呼び出しの履歴であるスタックトレースといった、デバッグに有用な情報が整形されて含まれます。例えば、echo構文でDomainExceptionオブジェクトを直接出力しようとしたり、文字列と連結したりした場合に、このメソッドが自動的に呼び出されます。これにより、開発者は例外オブジェクトが持つ詳細な情報を簡単に文字列として取得でき、エラーログへの記録やデバッグ時の画面表示を容易に行うことが可能になります。

Copy
1<?php
2
3try {
4    throw new DomainException("ドメインが無効です。", 400);
5} catch (DomainException $e) {
6    // 例外オブジェクトを文字列として出力する際に __toString() が暗黙的に呼び出されます。
7    echo $e;
8}
9
10?>

引数なし

引数はありません

string

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