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

getTraceAsStringメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年12月16日

基本的な使い方

getTraceAsStringメソッドは、例外のスタックトレースを文字列として取得するために使用するメソッドです。このメソッドは、LogicExceptionクラスが実装するThrowableインターフェースから継承されています。そのため、LogicExceptionだけでなく、PHPにおける全ての例外オブジェクトで使用することが可能です。スタックトレースとは、プログラムの実行過程を記録したもので、例外が発生した時点までの関数やメソッドの呼び出し履歴を順番に示したものです。具体的には、どのファイルの何行目でどの関数が呼び出され、それが次にどの関数を呼び出したかといった詳細情報が含まれます。このメソッドを呼び出すと、これらの呼び出し履歴が整形された読みやすい文字列として返されます。主にデバッグの場面で利用され、try-catchブロック内で捕捉した例外オブジェクトからこのメソッドを呼び出すことで、エラーログに詳細な情報を記録し、例外発生の原因特定や、そこに至るまでの処理の流れを追跡するのに役立ちます。パラメータは不要で、戻り値としてスタックトレースを表す文字列を返します。

構文(syntax)


1<?php
2function performLogic() {
3    // 意図的にロジックエラーを発生させます。
4    throw new LogicException("Logic error example.");
5}
6
7function executeTask() {
8    performLogic();
9}
10
11try {
12    executeTask();
13} catch (LogicException $e) {
14    // 例外がスローされた時点のバックトレースを文字列として取得します。
15    $traceString = $e->getTraceAsString();
16
17    // 取得した文字列を出力します。
18    echo $traceString;
19}
20?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このメソッドは、例外発生時のコールスタック（処理の呼び出し履歴）を文字列形式で返します。

サンプルコード

PHP LogicExceptionのスタックトレースを取得する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * ユーザーデータを処理するクラス。
7 */
8class UserProcessor
9{
10    /**
11     * ユーザーIDを検証し、処理を実行します。
12     *
13     * @param mixed $userId 検証するユーザーID
14     * @return void
15     * @throws LogicException ユーザーIDが整数でない場合 (ロジックエラー)
16     */
17    public function process(mixed $userId): void
18    {
19        // 本来、この関数に到達する前に型チェックが済んでいるべきという設計思想のもと、
20        // 万が一、整数以外の値が渡された場合はプログラムの論理的エラーとみなします。
21        if (!is_int($userId)) {
22            throw new LogicException('User ID must be an integer.');
23        }
24
25        echo "Processing user ID: {$userId}" . PHP_EOL;
26    }
27
28    /**
29     * アプリケーションのエントリーポイントとなるメソッド。
30     *
31     * @param mixed $id
32     * @return void
33     */
34    public function runApplication(mixed $id): void
35    {
36        $this->process($id);
37    }
38}
39
40// メインの処理
41try {
42    $processor = new UserProcessor();
43    // わざとロジックエラーを発生させるために、整数以外の値を渡します。
44    $processor->runApplication('user-123');
45} catch (LogicException $e) {
46    // catchブロックで LogicException を捕捉します。
47    echo 'A logic error occurred!' . PHP_EOL;
48    echo 'Error Message: ' . $e->getMessage() . PHP_EOL;
49    echo '--------------------' . PHP_EOL;
50    echo 'Stack Trace:' . PHP_EOL;
51
52    // getTraceAsString()メソッドを呼び出し、例外が発生した時点までの
53    // 関数の呼び出し履歴（スタックトレース）を文字列として取得し、出力します。
54    // これにより、どのファイルの何行目で、どのメソッド呼び出しが例外の原因となったかを追跡できます。
55    echo $e->getTraceAsString();
56}

LogicExceptionクラスに属するgetTraceAsString()メソッドは、例外が発生した時点までのプログラムの実行履歴（スタックトレース）を、人間が読みやすい形式の文字列として取得するために使用します。このメソッドは引数を取らず、戻り値としてスタックトレース情報を含む文字列を返します。

このサンプルコードでは、整数であるべきユーザーIDに文字列が渡された場合に、プログラムの論理的な誤りを示すLogicExceptionを意図的に発生させています。try...catch構文によってこの例外を捕捉し、catchブロック内で$e->getTraceAsString()を呼び出しています。

その結果、例外が発生するまでにどのファイルの何行目で、どの関数やメソッドがどのような順序で呼び出されたか、という詳細な情報が文字列として得られます。この情報を確認することで、エラーの原因となった処理の流れを正確に追跡することができ、プログラムのデバッグ作業を効率的に進めることが可能になります。

getTraceAsString()メソッドは、例外発生の原因を特定するデバッグ作業で非常に役立ちます。このメソッドが返すスタックトレースには、プログラムの内部構造やサーバーのファイルパスといった機密情報が含まれる可能性があります。そのため、開発中は有用ですが、本番環境でエラー内容をそのまま画面に出力すると、セキュリティ上の脆弱性につながる危険があります。運用時には、ユーザーには一般的なエラーメッセージのみを表示し、スタックトレースはエラーログファイルなど開発者のみが確認できる場所に記録するようにしてください。LogicExceptionは、プログラムの論理的な誤りを示す例外として使うのが一般的です。