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

__toStringメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

__toStringメソッドは、JsonExceptionオブジェクトが持つ例外情報を、人間が読みやすい形式の文字列として生成するメソッドです。このメソッドはPHPの「マジックメソッド」の一つであり、開発者が直接呼び出すことは通常ありません。代わりに、例外オブジェクトをecho文で画面に出力しようとしたり、文字列としてログファイルに書き込んだりするなど、オブジェクトを文字列として扱う必要がある文脈でPHPによって自動的に呼び出されます。このメソッドが実行されると、例外のクラス名、コンストラクタで設定されたエラーメッセージ、エラーコード、例外がスローされたファイル名と行番号、そしてそこに至るまでの関数呼び出しの履歴であるスタックトレースといった、デバッグに役立つ情報がすべて整形された一つの文字列が返されます。これにより、try-catchブロックでJsonExceptionを捕捉した際に、発生したエラーの詳細な情報を一つの文字列として簡単に取得し、確認することができます。

構文(syntax)

1<?php
2
3try {
4    json_decode('{', flags: JSON_THROW_ON_ERROR);
5} catch (JsonException $e) {
6    echo $e;
7}

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

JsonException::__toString メソッドは、例外オブジェクトを文字列として表現したものを返します。これにより、例外発生時の詳細情報をプログラムやログで確認できるようになります。

関連コンテンツ