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

__toStringメソッドは、BadMethodCallExceptionオブジェクトが文字列として扱われた際に、その例外情報を人間が読みやすい形式の文字列に変換して返す処理を実行するメソッドです。このメソッドはPHPのマジックメソッドの一つであり、開発者が明示的に呼び出すことは通常ありません。例えば、catchブロックで捕捉した例外オブジェクトをechoで出力しようとしたり、ログファイルに書き込むために文字列と連結したりすると自動的に呼び出されます。返される文字列には、例外クラス名（BadMethodCallException）、設定された例外メッセージ、例外がスローされたファイル名と行番号、そしてスタックトレースが標準的なフォーマットで含まれます。スタックトレースとは、例外が発生するまでにどのメソッドや関数がどのような順番で呼び出されたかを示す呼び出し履歴のことで、エラーの原因を特定する上で非常に重要な情報源となります。このメソッドは親クラスであるExceptionクラスから継承されたものであり、デバッグプロセスにおいて例外の詳細を簡単かつ包括的に把握するために不可欠な機能を提供します。

Copy
1<?php
2
3try {
4    // BadMethodCallException を意図的にスローする例
5    // 本来は未定義のメソッド呼び出しなどで発生する
6    throw new BadMethodCallException("存在しないメソッドが呼び出されました。", 123);
7} catch (BadMethodCallException $e) {
8    // 例外オブジェクトを文字列として扱うと __toString() が自動的に呼び出される
9    // 例外の文字列表現を取得する
10    $exceptionString = $e->__toString();
11    
12    echo $exceptionString;
13}
14
15?>

引数なし

引数はありません

string

このメソッドは、例外オブジェクトの文字列表現を返します。例外が発生した状況を把握するために利用できます。