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

Copy
1<?php
2
3/**
4 * 固定容量のキューを表すクラス。
5 * 容量を超えて要素を追加しようとすると OverflowException をスローします。
6 */
7class FixedQueue
8{
9    private array $elements = [];
10    private int $capacity;
11
12    /**
13     * @param int $capacity キューの最大容量
14     */
15    public function __construct(int $capacity)
16    {
17        $this->capacity = $capacity;
18    }
19
20    /**
21     * キューに要素を追加します。
22     *
23     * @param mixed $element 追加する要素
24     * @throws OverflowException キューが満杯の場合
25     */
26    public function enqueue(mixed $element): void
27    {
28        // 現在の要素数が容量以上の場合
29        if (count($this->elements) >= $this->capacity) {
30            // 容量オーバーを示す例外を、具体的なエラーメッセージと共にスローする
31            throw new OverflowException("キューが満杯です。要素を追加できません。");
32        }
33        $this->elements[] = $element;
34        echo "「{$element}」を追加しました。" . PHP_EOL;
35    }
36}
37
38// --- メイン処理 ---
39
40try {
41    // 容量が2のキューを作成
42    $queue = new FixedQueue(2);
43
44    $queue->enqueue("タスクA");
45    $queue->enqueue("タスクB");
46
47    // 3つ目の要素を追加しようとすると、OverflowExceptionがスローされる
48    $queue->enqueue("タスクC");
49
50} catch (OverflowException $e) {
51    // catchブロックで例外を捕捉する
52    // $e->getMessage() を使って、スローされた例外のメッセージを取得し表示する
53    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
54}

PHPのOverflowException::getMessage()メソッドは、スローされたOverflowExceptionオブジェクトから、エラーメッセージを取得するために使用されます。OverflowExceptionは、配列やキューなどのコンテナが満杯の状態で要素を追加しようとした場合など、容量オーバーを示すエラーが発生した際に使われる例外クラスです。このメソッドは引数を取らず、戻り値として例外発生時に設定されたエラーメッセージの文字列を返します。

サンプルコードでは、容量が固定されたキューを表すFixedQueueクラスを定義しています。enqueueメソッドは、キューの容量を超えて要素を追加しようとすると、「キューが満杯です。要素を追加できません。」という具体的なメッセージを持たせたOverflowExceptionをスローします。

メイン処理ではtry...catch構文を使用しています。tryブロック内で、容量が2のキューに3つ目の要素を追加しようとすることで、意図的に例外を発生させています。このスローされた例外はcatchブロックで捕捉され、変数$eに代入されます。最後に$e->getMessage()を呼び出すことで、例外オブジェクトに格納されていたメッセージを取得し、エラー内容として画面に表示しています。これにより、プログラム実行時になぜエラーが発生したのかを具体的に知ることができます。

Copy
1<?php
2
3/**
4 * OverflowExceptionからエラーメッセージを取得する例
5 */
6function demonstrateGetMessageFromOverflowException(): void
7{
8    // サイズが2の固定長の配列を作成します。
9    // インデックスは 0 と 1 のみ有効です。
10    $fixedArray = new SplFixedArray(2);
11    $fixedArray[0] = 'Apple';
12    $fixedArray[1] = 'Banana';
13
14    try {
15        // 配列のサイズを超えるインデックス(2)に要素を追加しようとします。
16        // これにより OverflowException がスローされます。
17        echo "配列の範囲外に要素を追加しようとしています...\n";
18        $fixedArray[2] = 'Cherry';
19    } catch (OverflowException $e) {
20        // catchブロックでスローされた例外を捕捉します。
21        // OverflowException は RuntimeException の一種です。
22
23        // getMessage() メソッドを使用して、例外オブジェクトに格納されている
24        // エラーメッセージを取得し、表示します。
25        echo "例外がキャッチされました！\n";
26        echo "エラーメッセージ: " . $e->getMessage() . "\n";
27    }
28}
29
30// 関数を実行して結果を確認します。
31demonstrateGetMessageFromOverflowException();
32
33?>

このPHPサンプルコードは、OverflowExceptionという種類の例外が発生した際に、その詳細なエラーメッセージを取得するgetMessage()メソッドの使い方を示しています。

コードでは、まずSplFixedArrayを使用して、要素数が2つに固定された配列を作成します。次にtryブロックの中で、この配列の許容範囲を超える3番目の位置（インデックス2）に、意図的にデータを追加しようと試みます。この操作は配列の容量を超えているため、OverflowExceptionが発生します。

プログラムはcatchブロックでこの発生した例外を捕捉します。ここで、捕捉した例外オブジェクト（変数$e）に対してgetMessage()メソッドを呼び出しています。このgetMessage()メソッドは引数を必要とせず、例外が発生した具体的な理由を説明する文字列を戻り値として返します。サンプルコードでは、この戻り値であるエラーメッセージを画面に出力することで、どのような問題が起きたのかを確認できます。このようにgetMessage()は、プログラム実行時に発生した問題の原因を特定するために非常に役立ちます。