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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 配列をラップし、文字列として表現できるようにするクラス。
7 *
8 * このクラスのインスタンスを文字列として扱おうとすると、
9 * __toString() メソッドが自動的に呼び出され、
10 * 保持している配列をJSON形式の文字列で返します。
11 * 通常、配列を直接echoしようとすると "Array to string conversion" という
12 * Noticeエラーが発生しますが、このクラスを使うことで回避できます。
13 */
14final class ArrayStringifier
15{
16    /**
17     * @param array<mixed> $data 文字列に変換したい配列
18     */
19    public function __construct(private array $data)
20    {
21    }
22
23    /**
24     * オブジェクトが文字列として扱われた際に自動的に呼び出されるマジックメソッド。
25     *
26     * @return string 配列を人間が読みやすいJSON形式にエンコードした文字列を返します。
27     */
28    public function __toString(): string
29    {
30        // json_encode を使用して、配列を整形されたJSON文字列に変換します。
31        // JSON_UNESCAPED_UNICODE: 日本語などのマルチバイト文字をエスケープしません。
32        // JSON_PRETTY_PRINT:      人間が読みやすいようにインデントや改行を入れます。
33        $json = json_encode(
34            $this->data,
35            JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT
36        );
37
38        // json_encodeが失敗した場合 (例: 無限再帰など) は空の文字列を返します。
39        return $json === false ? '' : $json;
40    }
41}
42
43// 文字列に変換したいサンプル配列
44$user_data = [
45    'id' => 123,
46    'name' => '山田 太郎',
47    'roles' => ['admin', 'editor'],
48    'active' => true,
49];
50
51// 配列をラップするクラスのインスタンスを作成します。
52$stringifiable_array = new ArrayStringifier($user_data);
53
54// インスタンスを直接 echo すると、__toString() メソッドが呼び出されます。
55echo $stringifiable_array;
56

このサンプルコードは、PHPの特殊なメソッドである __toString の使い方を示しています。__toString は「マジックメソッド」の一種で、クラスのインスタンス（オブジェクト）が echo による出力など、文字列として扱われる際に自動的に呼び出されるメソッドです。

PHPでは、通常、配列を直接文字列として出力しようとすると「Array to string conversion」というNoticeエラーが発生します。この問題を解決するため、サンプルコードでは ArrayStringifier というクラスを定義しています。このクラスは、コンストラクタで受け取った配列を内部に保持します。

そして、このクラスのインスタンスが文字列として評価されると、__toString メソッドが起動します。このメソッドは引数を取らず、必ず string 型の値を返す決まりになっています。コード内では json_encode 関数を用いて、保持している配列を読みやすいJSON形式の文字列に変換し、その結果を返却しています。

最後に $stringifiable_array というインスタンスを echo すると、__toString メソッドが実行され、結果として配列の内容が整形されたJSON文字列として出力されます。このように、オブジェクトの文字列表現を自由に定義できるのが __toString メソッドの特長です。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 書籍情報を表現するクラス
7 *
8 * このクラスのインスタンスが文字列として扱われる際に、
9 * __toString() メソッドが自動的に呼び出されます。
10 */
11class Book
12{
13    /**
14     * @param string $title 書籍のタイトル
15     * @param string $author 著者名
16     */
17    public function __construct(
18        private string $title,
19        private string $author
20    ) {
21    }
22
23    /**
24     * オブジェクトを文字列に変換した際の表現を定義します。
25     *
26     * @return string オブジェクトの文字列表現
27     */
28    public function __toString(): string
29    {
30        return sprintf('『%s』(著者: %s)', $this->title, $this->author);
31    }
32}
33
34// Bookクラスのインスタンスを作成します。
35$book = new Book('PHP逆引きレシピ', '山田 太郎');
36
37// echo文でオブジェクトを出力しようとすると、__toString()メソッドが自動的に呼び出されます。
38echo $book . PHP_EOL;
39
40// 文字列として連結しようとした場合も同様です。
41$message = 'おすすめの本: ' . $book;
42echo $message . PHP_EOL;
43
44// 明示的に文字列へキャスト(変換)することもできます。
45$bookAsString = (string)$book;
46echo $bookAsString . PHP_EOL;

PHPの__toString()は、オブジェクトが文字列として扱われる際に自動的に呼び出される「マジックメソッド」と呼ばれる特別なメソッドです。このメソッドをクラス内に定義することで、そのクラスから作成されたインスタンス（オブジェクト）が、文字列としてどのように表現されるかを自由に設定できます。

サンプルコードでは、書籍情報を表すBookクラスに__toString()メソッドが実装されています。このメソッドは引数を持たず、戻り値として必ずstring型（文字列）を返す必要があります。ここでは、sprintf関数を使って「『（タイトル）』(著者: （著者名）)」という形式の文字列を生成して返しています。

そのため、echoでBookオブジェクトを直接出力しようとしたり、文字列と連結しようとしたり、あるいは(string)を使って明示的に文字列へキャスト（型変換）したりすると、自動的に__toString()メソッドが呼び出されます。結果として、オブジェクトの代わりに、このメソッドで定義された整形済みの書籍情報文字列が使用されます。このように、オブジェクトの文字列表現を定義しておくと、デバッグやログ出力の際に非常に便利です。