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

Copy
1<?php
2
3/**
4 * ジェネレータの動作を模倣する関数。
5 * このジェネレータは一度値をyieldした後、すぐに閉じられます。
6 * これにより、後続の send() メソッド呼び出しで ClosedGeneratorException が発生する状況を作り出します。
7 *
8 * @return Generator
9 */
10function createClosedGenerator(): Generator
11{
12    yield '最初の処理結果'; // 最初の値を生成し、一旦停止
13    // ここで return することで、ジェネレータは閉じられた状態になります。
14    return;
15    // return の後のコードは実行されません。
16    yield 'これは生成されない値';
17}
18
19// ジェネレータオブジェクトを生成
20$generator = createClosedGenerator();
21
22// ジェネレータを一度進めることで、'最初の処理結果' が yield され、
23// その後すぐに return が実行されてジェネレータは閉じられます。
24$generator->current(); // '最初の処理結果' を取得
25$generator->next();    // ジェネレータを次の状態へ進める（return が実行され、閉じられる）
26
27try {
28    // 閉じられたジェネレータに対して send() メソッドを呼び出そうとすると、
29    // ClosedGeneratorException がスローされます。
30    echo "閉じられたジェネレータに値を送ろうとします...\n";
31    $generator->send('これは届かない値');
32    echo "エラーが発生しませんでした。\n"; // ここには到達しない
33} catch (ClosedGeneratorException $e) {
34    // ClosedGeneratorException を捕捉した場合の処理
35    echo "ClosedGeneratorException が捕捉されました！\n";
36
37    // 例外オブジェクトを文字列として出力します。
38    // PHP はこの際、内部的にオブジェクトの __toString() マジックメソッドを呼び出します。
39    // ClosedGeneratorException (およびその親クラス Exception) の __toString() は、
40    // 例外のメッセージ、ファイル名、行番号などを含む詳細な文字列を返します。
41    echo "例外の文字列表現:\n";
42    echo $e;
43}
44

このPHPコードは、ジェネレータが閉じられた際に発生するClosedGeneratorExceptionと、その例外オブジェクトを文字列として表示する方法を示しています。

まず、createClosedGenerator関数は、yieldで値を生成した直後にreturnでジェネレータを閉じます。ジェネレータが閉じられた状態でsend()メソッドを呼び出そうとすると、ClosedGeneratorExceptionが発生し、try-catchブロックで捕捉されます。

捕捉された例外オブジェクト$eをecho $e;のように直接出力しようとすると、PHPは内部的にClosedGeneratorExceptionオブジェクトの__toString()メソッドを呼び出します。__toString()メソッドは引数を取らず、例外のメッセージ、発生ファイル名、行番号など、例外に関する詳細情報を含む文字列を戻り値として返します。この結果、echoによって例外の詳細な内容が画面に出力されます。

この機能は、プログラム実行中に発生したエラーの情報を確認し、デバッグを行う際に役立ちます。

Copy
1<?php
2
3/**
4 * ジェネレータ関数を定義します。
5 * このジェネレータは 'First value' を一度だけyieldし、その後閉じられることを想定しています。
6 */
7function simpleGenerator(): Generator
8{
9    yield 'First value';
10    // この後のyieldは、ジェネレータが途中で閉じられた場合、到達しません。
11    yield 'Second value';
12}
13
14/**
15 * ClosedGeneratorException の __toString() メソッドの動作を示すサンプルコード。
16 *
17 * ClosedGeneratorException は、閉じられたジェネレータから値を生成しようとした場合に
18 * スローされる例外です。この例外オブジェクトが文字列コンテキストで使用されると、
19 * PHPは自動的に __toString() メソッドを呼び出し、例外に関する詳細情報を含む
20 * 文字列を返します。
21 */
22try {
23    // ジェネレータをインスタンス化します。
24    $generator = simpleGenerator();
25
26    echo "--- ジェネレータの初期状態 ---" . PHP_EOL;
27    echo "Current value: " . $generator->current() . PHP_EOL; // 'First value' を表示
28    $generator->next(); // ジェネレータを次の状態へ進めますが、まだ値を読み取っていません。
29
30    echo "--- ジェネレータを明示的に閉じる ---" . PHP_EOL;
31    // ジェネレータを明示的に閉じます。
32    $generator->close();
33    echo "ジェネレータは閉じられました。" . PHP_EOL;
34
35    echo "--- 閉じられたジェネレータにアクセスを試みる ---" . PHP_EOL;
36    // 閉じられたジェネレータから次の値を生成しようとすると、
37    // ClosedGeneratorException がスローされます。
38    $generator->next();
39
40    // この行は、例外がスローされるため実行されません。
41    echo "このメッセージは表示されません。" . PHP_EOL;
42
43} catch (ClosedGeneratorException $e) {
44    // ClosedGeneratorException を捕捉します。
45    echo "--- ClosedGeneratorException を捕捉しました ---" . PHP_EOL;
46
47    // 例外オブジェクトを直接 echo すると、PHPは自動的に __toString() メソッドを呼び出します。
48    // これにより、例外の種類、メッセージ、ファイル名、行番号などが含まれる文字列が出力されます。
49    echo "例外オブジェクトを直接出力 (自動的に __toString() が呼び出される):" . PHP_EOL;
50    echo $e;
51    echo PHP_EOL;
52
53    // __toString() メソッドを明示的に呼び出すことも可能です。
54    echo "例外オブジェクトの __toString() を明示的に呼び出す:" . PHP_EOL;
55    echo $e->__toString();
56    echo PHP_EOL;
57
58} catch (Exception $e) {
59    // その他の例外を捕捉する場合
60    echo "--- 予期せぬ例外を捕捉しました ---" . PHP_EOL;
61    echo $e->getMessage() . PHP_EOL;
62}
63
64?>

PHPのClosedGeneratorExceptionクラスに定義されている__toStringメソッドは、オブジェクトを文字列に変換するための特別なメソッドです。引数はなく、例外の詳細情報を含む文字列を返します。

このメソッドの主な役割は、閉じられたジェネレータから値を生成しようとしてClosedGeneratorExceptionが発生した際に、その例外オブジェクトをechoやログ出力などで文字列として扱おうとしたときに、PHPが自動的に呼び出すことです。これにより、例外の種類、エラーメッセージ、例外が発生したファイル名や行番号など、デバッグに役立つ情報が整形された文字列として出力されます。

サンプルコードでは、一度閉じたジェネレータにアクセスしようとするとClosedGeneratorExceptionがスローされます。この例外を捕捉し、例外オブジェクトを直接echo $e;と出力すると、PHPは内部的に$e->__toString()を呼び出し、例外の詳細な情報を表示します。また、明示的に$e->__toString();と呼び出すことも可能です。この機能は、プログラムの予期せぬエラー発生時に、その原因を素早く特定するために非常に役立ちます。