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

『__toStringメソッドは、LogicExceptionオブジェクトの文字列表現を生成して返すメソッドです。このメソッドは、オブジェクトが文字列として扱われる文脈で自動的に呼び出されます。例えば、echoで例外オブジェクトを出力しようとした場合や、ログファイルに書き出すために文字列と連結した場合などに内部的に実行されます。返される文字列には、デバッグに役立つ詳細な情報が含まれています。具体的には、例外のクラス名、コンストラクタで設定されたエラーメッセージ、エラーコード、例外がスローされたファイル名と行番号、そして例外が発生するまでの関数の呼び出し履歴を示すスタックトレースが、整形された形式でまとめられています。この情報により、開発者はプログラムのどこで、どのような経緯で論理エラーが発生したのかを迅速に把握できます。LogicExceptionにおけるこのメソッドは、基底クラスであるExceptionクラスから継承された機能であり、開発者が直接呼び出すことはほとんどありません。例外処理においてエラー内容を確認する際に、非常に重要な役割を果たします。

Copy
1<?php
2
3try {
4    // LogicExceptionを意図的に発生させます。
5    throw new LogicException("論理的なエラーが発生しました。", 100);
6} catch (LogicException $e) {
7    // 例外オブジェクトを文字列として出力すると、
8    // __toString() メソッドが自動的に呼び出されます。
9    echo $e;
10}
11
12?>

引数なし

引数はありません

string

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