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

getTraceAsStringメソッドは、PHPの標準エラークラスであるArithmeticErrorクラスに属し、エラーや例外が発生した際のスタックトレース情報を文字列として取得するメソッドです。スタックトレースとは、プログラムがエラーに至るまでの関数やメソッドの呼び出し履歴を詳細に記録したものです。

このメソッドは引数を取らず、エラーが発生した時点での呼び出しスタックの情報を、人間が読みやすい形式の文字列として返します。具体的には、「ファイル名:行数 - 関数名」といった形式で、エラーが発生した箇所からさかのぼって、どのような経路でそのエラーが引き起こされたのかを順序立てて示します。

ArithmeticErrorは算術演算に関するエラーを表しますが、このgetTraceAsStringメソッド自体はPHPの全ての例外やエラーの基底となるThrowableインターフェースで定義されているため、他の多くのエラーや例外クラスでも共通して利用できます。システム開発において予期せぬエラーが発生した際、このメソッドを利用して詳細なスタックトレースをエラーログに出力することで、エラーの発生源を迅速に特定し、問題を解決するデバッグ作業を大幅に効率化できます。これにより、プログラムの安定性を高め、保守性を向上させる上で非常に役立ちます。

Copy
1<?php
2try {
3    // ArithmeticError の子クラスである DivisionByZeroError を発生させる
4    $result = 10 / 0;
5} catch (ArithmeticError $e) {
6    // 発生した ArithmeticError オブジェクトに対して getTraceAsString() メソッドを呼び出す
7    echo $e->getTraceAsString();
8}

引数なし

引数はありません

string

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