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

Copy
1<?php
2
3/**
4 * PHPの__toStringマジックメソッドの動作と、配列の文字列化について学ぶサンプルコードです。
5 * FiberErrorはPHPの内部クラスで、オブジェクトが文字列として扱われる際に__toStringメソッドが自動的に呼び出されます。
6 * この例では、カスタムクラスでの__toStringの実装と、配列の安全な文字列化方法も示します。
7 */
8
9// 1. カスタムクラスでの__toStringメソッドの実装例
10// このクラスは内部に配列データを持ち、そのオブジェクトが文字列として扱われる際に、
11// __toStringメソッドを使って整形された文字列を返します。
12class CustomObjectWithArray
13{
14    private string $id;
15    private array $details;
16
17    public function __construct(string $id, array $details)
18    {
19        $this->id = $id;
20        $this->details = $details;
21    }
22
23    /**
24     * このオブジェクトが文字列として扱われる際（例: echo $object;）に自動的に呼び出されます。
25     * 内部の配列データをJSON形式で文字列化し、オブジェクト情報と結合して返します。
26     *
27     * @return string オブジェクトの文字列表現
28     */
29    public function __toString(): string
30    {
31        return sprintf(
32            "CustomObject[ID: %s, Details: %s]",
33            $this->id,
34            json_encode($this->details, JSON_UNESCAPED_UNICODE)
35        );
36    }
37}
38
39// 2. FiberError（PHP内部クラス）の__toStringメソッドの動作
40echo "--- FiberErrorの__toStringメソッド ---" . PHP_EOL;
41try {
42    // FiberErrorはPHPのFiber機能に関連するエラーオブジェクトです。
43    // 例外オブジェクトを直接echoなどの文字列コンテキストで利用すると、
44    // その内部で定義されている__toStringメソッドが自動的に呼び出され、
45    // エラー情報が文字列として整形されて出力されます。
46    throw new FiberError("Fiber operation failed due to an unexpected state.");
47} catch (FiberError $e) {
48    // FiberErrorオブジェクトを直接文字列として出力すると、__toStringが機能します。
49    echo "捕獲されたFiberError: " . $e . PHP_EOL;
50}
51
52echo PHP_EOL . "--- カスタムオブジェクトの__toStringメソッド ---" . PHP_EOL;
53$myCustomObject = new CustomObjectWithArray(
54    "ORDER-001",
55    ['customer' => 'Alice', 'items' => ['Pen', 'Notebook'], 'total' => 1500]
56);
57// CustomObjectWithArrayオブジェクトを直接echoすると、
58// CustomObjectWithArray::__toStringメソッドが呼び出されます。
59echo "カスタムオブジェクトの文字列化: " . $myCustomObject . PHP_EOL;
60
61// 3. 配列の文字列化
62// PHPの配列は__toStringメソッドを持たないため、直接echoしようとすると警告が発生します。
63// 配列の内容を文字列として出力するには、専用の関数を使う必要があります。
64echo PHP_EOL . "--- 配列の安全な文字列化 ---" . PHP_EOL;
65$dataArray = [
66    'product' => 'PHP Guide',
67    'version' => '8.x',
68    'topics' => ['Fibers', 'Enums', 'Attributes']
69];
70
71echo "配列を直接echoしようとすると警告が出ます (コメントアウト済み):" . PHP_EOL;
72// echo "直接出力: " . $dataArray . PHP_EOL; // この行を有効にすると "Array to string conversion" 警告が発生します。
73
74echo "配列を文字列化する一般的な方法 (json_encode):" . PHP_EOL;
75// json_encodeは配列をJSON形式の文字列に変換します。
76echo "JSON形式で出力:\n" . json_encode($dataArray, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) . PHP_EOL;
77
78echo PHP_EOL . "別の配列を文字列化する方法 (print_r関数):" . PHP_EOL;
79// print_r関数は配列の人間が読める形式を返します。
80// 第二引数にtrueを渡すと、結果を画面に出力せず文字列として返します。
81echo "print_rで出力:\n" . print_r($dataArray, true) . PHP_EOL;
82
83?>

PHPでは、オブジェクトが文字列として扱われる際（例: echo $object;）に、自動的に__toStringというマジックメソッドが呼び出されます。このメソッドは引数を持たず、必ずstring型を返す必要があります。オブジェクトを直接文字列として出力したい場合に、どのような情報を返すかを定義する役割があります。

サンプルコードでは、まずPHPの内部クラスであるFiberErrorの__toStringメソッドの動作を示しています。FiberErrorオブジェクトが例外として捕捉され、その後文字列として出力される際、その内部で定義された__toStringメソッドが呼び出され、エラーに関する詳細情報が文字列として整形されて返されます。これにより、エラー内容を簡単に確認できます。

また、独自のクラスでも__toStringメソッドを定義できます。例としてCustomObjectWithArrayクラスでは、オブジェクトのIDと内部に持つ配列データをjson_encodeで文字列化し、一つの整形された文字列として返すように実装されています。オブジェクトの内部に配列などの複雑なデータがある場合は、json_encodeやprint_rといった関数を使って適切に文字列化することが重要です。

PHPの配列はオブジェクトとは異なり、直接__toStringメソッドを持たないため、そのままechoしようとすると「Array to string conversion」という警告が発生します。配列の内容を文字列として表示するには、json_encode関数でJSON形式に変換するか、print_r関数（第2引数にtrueを指定）を使って人間が読みやすい形式に変換する方法が推奨されます。これらの方法を利用することで、配列データを正確かつ安全に文字列として扱えます。