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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 固定サイズのキューを表すクラス。
7 * 容量を超えて要素を追加しようとするとOverflowExceptionをスローします。
8 */
9class FixedSizeQueue
10{
11    private array $items = [];
12    private int $maxSize;
13
14    public function __construct(int $size)
15    {
16        $this->maxSize = $size;
17    }
18
19    public function enqueue(string $item): void
20    {
21        // キューが満杯の場合は、OverflowExceptionをスローする
22        if (count($this->items) >= $this->maxSize) {
23            throw new OverflowException("Queue is full.");
24        }
25        $this->items[] = $item;
26        echo "Added: {$item}\n";
27    }
28}
29
30/**
31 * キューの操作を実行し、例外を補足する関数。
32 */
33function runQueueExample(): void
34{
35    try {
36        // 容量が2のキューを作成
37        $queue = new FixedSizeQueue(2);
38
39        // 要素を追加
40        $queue->enqueue('apple');
41        $queue->enqueue('banana');
42
43        // ここで容量オーバーとなり、OverflowExceptionが発生する
44        $queue->enqueue('cherry');
45
46    } catch (OverflowException $e) {
47        // OverflowExceptionをキャッチする
48        echo "\nエラーが発生しました: " . $e->getMessage() . "\n\n";
49
50        // getTraceAsString() を使って、例外発生箇所までの呼び出し履歴（スタックトレース）を文字列として取得し、表示する
51        echo "--- スタックトレース ---\n";
52        echo $e->getTraceAsString();
53        echo "\n----------------------\n";
54    }
55}
56
57// 実行
58runQueueExample();

OverflowException::getTraceAsString()は、例外が発生した箇所までのプログラムの実行経路、すなわち「スタックトレース」を、整形された文字列として取得するためのメソッドです。プログラムのどこで、どのような順序で関数が呼び出されてエラーに至ったのかを調査する際に非常に役立ちます。

このサンプルコードでは、容量が2に制限されたキューFixedSizeQueueを定義しています。3つ目の要素'cherry'を追加しようとした際、enqueueメソッド内で容量オーバーとなりOverflowExceptionがスローされます。

try...catch構文によってこの例外が捕捉されると、catchブロック内の処理が実行されます。ここで呼び出されている$e->getTraceAsString()が今回の主役です。このメソッドは引数を取らず、戻り値としてスタックトレース全体の情報を一つの文字列で返します。出力結果には、どのファイルの何行目からどの関数が呼び出され、最終的に例外が発生したか、という一連の呼び出し履歴が表示されます。これにより、エラーの原因を特定するための重要な手がかりを得ることができます。