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

__toStringメソッドは、RangeExceptionオブジェクトを文字列に変換する際に、その例外の詳細情報を整形した文字列として返す処理を実行するメソッドです。このメソッドは、PHPに組み込まれている「マジックメソッド」の一つであり、オブジェクトを文字列として扱おうとした場合、例えば echo で出力しようとしたり、文字列と連結したりした場合に自動的に呼び出されます。RangeExceptionは、プログラムのロジックに問題があり、有効な範囲外の値が指定されたことを示す例外です。このメソッドが返す文字列には、例外のクラス名、設定されたメッセージ、例外コード、例外が発生したファイル名と行番号、そしてスタックトレース（例外発生地点に至るまでの関数の呼び出し履歴）といった、デバッグに不可欠な情報が含まれています。そのため、try...catch ブロックで例外を捕捉した際に、catch した例外オブジェクト変数を直接出力するだけで、エラーの原因を調査するための詳細な情報を簡単かつ一貫した形式で取得でき、開発やデバッグの効率を向上させます。

Copy
1<?php
2
3class RangeException extends LogicException
4{
5    public function __toString(): string
6    {
7        // このメソッドは Exception クラスから継承されます。
8        // 実際の処理は内部エンジンで実装されています。
9    }
10}

引数なし

引数はありません

string

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