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

Copy
1<?php
2
3/**
4 * simpleGenerator関数: 簡単なジェネレータを定義します。
5 * このジェネレータは1つの値をyieldし、その後完了します。
6 */
7function simpleGenerator(): Generator
8{
9    yield 'Hello';
10    // ジェネレータはここで完了します。
11}
12
13try {
14    $generator = simpleGenerator();
15    $generator->current(); // ジェネレータを最初の値 ('Hello') まで進めます。
16    $generator->next();    // ジェネレータを完了させます（これ以上yieldするものがありません）。
17
18    // 閉じられた（完了した）ジェネレータに値を送ろうとすると、
19    // ClosedGeneratorException が発生します。
20    $generator->send('World');
21
22} catch (ClosedGeneratorException $e) {
23    echo "--- ClosedGeneratorException が発生しました ---\n";
24    echo "メッセージ: " . $e->getMessage() . "\n\n";
25
26    // getTrace() メソッドは、例外が発生した時点のスタックトレースを配列として返します。
27    // 各配列要素は、呼び出し元のファイル、行、関数、クラスなどの情報を含みます。
28    echo "--- getTrace() の出力 (配列形式) ---\n";
29    print_r($e->getTrace());
30    echo "\n";
31
32    // getTraceAsString() メソッドは、同じスタックトレースを文字列形式で返します。
33    // これは、ログファイルへの出力やデバッグ時に人間が読みやすい形式としてよく使用されます。
34    // getTrace() の配列情報を整形して表示したものです。
35    echo "--- getTraceAsString() の出力 (文字列形式) ---\n";
36    echo $e->getTraceAsString();
37    echo "\n";
38}
39
40?>

PHPでは、ジェネレータが一度完了した後で再度値を送信しようとすると、ClosedGeneratorExceptionが発生します。このClosedGeneratorExceptionクラスに属するgetTrace()メソッドは、例外が発生した時点のプログラムの呼び出し履歴、いわゆるスタックトレースを取得するために使用されます。プログラムがどのような順序で関数やメソッドを呼び出して例外に至ったのかを詳細に把握できます。

getTrace()メソッドは引数を取りません。戻り値はarray型で、呼び出し履歴の各ステップが連想配列として含まれます。この配列の各要素には、ファイル名、行番号、呼び出された関数名やクラス名といった、詳細なデバッグ情報が格納されています。

サンプルコードでも示されているように、getTrace()が詳細な情報を配列として提供するのに対し、同じ情報をもとに人間が読みやすい文字列形式で出力するのがgetTraceAsString()メソッドです。getTraceAsString()は、特にログファイルへの出力や、デバッグ時にコンソールで内容を確認する際に非常に役立ちます。これらのメソッドを利用することで、ClosedGeneratorExceptionのような予期せぬエラーが発生した際に、その原因や発生箇所を素早く特定し、問題を解決するための手がかりを得ることができます。