【PHP8.x】BadMethodCallException::__toString()メソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ユーザー情報を表現するクラス。
7 *
8 * このクラスは、オブジェクトが文字列として扱われる際に
9 * どのように表現されるべきかを定義するために __toString() メソッドを実装しています。
10 * これは他の言語における `toString()` メソッドに相当する機能です。
11 */
12class User
13{
14    /**
15     * @param int $id ユーザーID
16     * @param string $name ユーザー名
17     * @param string $email メールアドレス
18     */
19    public function __construct(
20        private int $id,
21        private string $name,
22        private string $email
23    ) {
24    }
25
26    /**
27     * オブジェクトが文字列コンテキストで使用された際に自動的に呼び出されます。
28     *
29     * 例えば、`echo` でオブジェクトを出力しようとした場合や、
30     * 文字列と連結した場合に、このメソッドの戻り値が使用されます。
31     *
32     * @return string このオブジェクトの文字列表現
33     */
34    public function __toString(): string
35    {
36        return "User(ID: {$this->id}, Name: '{$this->name}', Email: '{$this->email}')";
37    }
38}
39
40// Userクラスのインスタンス（オブジェクト）を生成します。
41$user = new User(101, 'Taro Yamada', 'taro.yamada@example.com');
42
43// オブジェクトを直接 `echo` で出力しようとすると、__toString() メソッドが呼び出されます。
44echo $user;
45
46// 以下のように表示されます:
47// User(ID: 101, Name: 'Taro Yamada', Email: 'taro.yamada@example.com')
48

このPHPコードは、__toString()という特別なメソッドの使い方を示しています。これは、オブジェクトを文字列として扱おうとしたときに、そのオブジェクトがどのように表現されるべきかを定義するためのものです。他のプログラミング言語におけるtoString()メソッドと同様の機能を提供します。

サンプルコードのUserクラスには、__toString()メソッドが実装されています。このメソッドは引数を受け取らず、戻り値として必ず文字列（string）を返すように定められています。ここでは、ユーザーのID、名前、メールアドレスといった内部のプロパティ情報を見やすい形式の文字列に整形して返しています。

コードの最後でecho $user;を実行すると、PHPは$userオブジェクトを文字列として出力しようとします。このとき、内部で自動的に__toString()メソッドが呼び出され、そのメソッドが返した文字列が画面に表示されます。このように__toString()を定義しておくことで、オブジェクトの状態をデバッグなどで確認する際に、中身を分かりやすく表示させることが可能になります。