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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ユーザーの年齢を検証します。
7 *
8 * @param mixed $age 検証する年齢
9 * @throws InvalidArgumentException 年齢が整数でない場合にスローされます
10 */
11function validateAge(mixed $age): void
12{
13    // 引数が整数でない場合、InvalidArgumentExceptionをスローします。
14    if (!is_int($age)) {
15        throw new InvalidArgumentException('年齢は整数で指定してください。');
16    }
17    echo "年齢 {$age} は有効です。" . PHP_EOL;
18}
19
20/**
21 * ユーザー情報を登録する処理をシミュレートします。
22 * この関数は内部で validateAge を呼び出します。
23 *
24 * @param string $name ユーザー名
25 * @param mixed $age ユーザーの年齢
26 */
27function registerUser(string $name, mixed $age): void
28{
29    echo "ユーザー '{$name}' の登録処理を開始します..." . PHP_EOL;
30    validateAge($age);
31    echo "ユーザー '{$name}' の登録が完了しました。" . PHP_EOL;
32}
33
34// --- メインの実行ブロック ---
35
36try {
37    // 意図的に不正な型の引数（文字列）を渡して、例外を発生させます。
38    registerUser('Taro', 'twenty');
39} catch (InvalidArgumentException $e) {
40    // スローされた InvalidArgumentException をここで捕捉します。
41    echo '--------------------------------------------------' . PHP_EOL;
42    echo 'エラー: ' . $e->getMessage() . PHP_EOL;
43    echo '--------------------------------------------------' . PHP_EOL;
44    echo 'スタックトレース:' . PHP_EOL;
45
46    // getTraceAsString()メソッドを呼び出します。
47    // これにより、例外が発生した場所から、どの関数がどの順番で呼び出されたかの履歴（スタックトレース）が
48    // 文字列として取得でき、デバッグに役立ちます。
49    echo $e->getTraceAsString();
50    echo PHP_EOL;
51    echo '--------------------------------------------------' . PHP_EOL;
52}

InvalidArgumentExceptionクラスのgetTraceAsStringメソッドは、例外が発生した時点までのプログラムの実行経路（スタックトレース）を、人間が読みやすい文字列形式で取得するためのものです。このメソッドは引数を取らず、戻り値としてスタックトレースを表す文字列を返します。

このサンプルコードでは、まずregisterUser関数が呼び出され、その内部でvalidateAge関数が呼び出されます。しかし、validateAge関数に予期しない文字列型の値が渡されたため、InvalidArgumentExceptionという種類の例外が発生（スロー）します。

プログラムはtry...catch構文でこの例外を捕捉します。catchブロック内では、捕捉した例外オブジェクト（変数 $e）に対して$e->getTraceAsString()を実行しています。これにより、例外がスローされた地点から遡って、どのファイルの何行目で、どの関数がどの順番で呼び出されたかという詳細な履歴が文字列として得られます。この情報は、エラーの原因がプログラムのどこにあるのかを特定する際の、非常に重要な手がかりとなります。