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

__toStringメソッドは、DateExceptionクラスのオブジェクトを文字列として表現するために実行されるメソッドです。PHP 8において、例外オブジェクトを文字列として扱う必要がある場合に、自動的にこのメソッドが呼び出されます。DateExceptionクラスは、日付や時刻に関連する例外を扱うためのクラスであり、このメソッドを実装することで、例外の内容を分かりやすく文字列として出力できます。

具体的には、echo文や文字列結合演算子（.）などを使用してDateExceptionオブジェクトを出力しようとした際に、__toStringメソッドが自動的に呼ばれ、その戻り値が文字列として使用されます。このメソッドをオーバーライドすることで、例外に関する有用な情報（エラーコード、メッセージ、発生場所など）を文字列として整形し、デバッグやログ出力に役立てることが可能です。

例えば、__toStringメソッド内で、例外メッセージだけでなく、例外が発生した日時やファイル名、行番号などの情報を含めた文字列を生成し、返すように実装することで、エラー発生時の状況を詳細に把握することができます。このメソッドが定義されていない場合、PHPはデフォルトの文字列表現を試みますが、カスタマイズされた情報を出力したい場合には、必ずオーバーライドする必要があります。DateExceptionクラスの__toStringメソッドは、日付関連の例外情報を文字列として効果的に表現するための重要な機能を提供します。

Copy
1<?php
2class DateException extends Exception {
3    public function __toString(): string {
4        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
5    }
6}
7?>

引数なし

引数はありません

string

このメソッドは、DateException オブジェクトの文字列表現を返します。これにより、例外が発生した際の情報を文字列として取得できます。