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

『getTraceAsStringメソッドは、例外のスタックトレースを文字列として取得するメソッドです』

スタックトレースとは、プログラムの実行中に例外が発生した時点までの、関数やメソッドの呼び出し履歴を記録したものです。この履歴には、どのファイルの何行目でどの関数が呼び出され、その結果として次にどの関数が呼び出されたか、といった一連の流れが詳細に記録されています。このメソッドが返す文字列には、各ステップのファイル名、行番号、クラス名、関数名が含まれており、プログラムのどこで、どのような経緯で問題が発生したのかを正確に追跡するのに役立ちます。主に、開発中のデバッグ作業や、運用中のエラーログ記録のために使用されます。

DateInvalidTimeZoneExceptionは無効なタイムゾーンが指定された場合にスローされる例外ですが、この例外オブジェクトに対してgetTraceAsStringメソッドを呼び出すことで、問題のコード箇所を特定するための重要な手がかりを得ることができます。このメソッドは、すべての例外クラスの基底クラスであるExceptionクラスで定義されているため、DateInvalidTimeZoneExceptionを含むPHPの多くの例外オブジェクトで共通して利用することが可能です。

Copy
1<?php
2
3try {
4    // DateInvalidTimeZoneException のインスタンスを生成（通常はPHPの内部で発生）
5    throw new DateInvalidTimeZoneException("無効なタイムゾーンが指定されました。");
6} catch (DateInvalidTimeZoneException $e) {
7    // 捕捉した例外インスタンスからスタックトレースを文字列として取得
8    $traceString = $e->getTraceAsString();
9}

引数なし

引数はありません

string

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