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

Copy
1<?php
2
3/**
4 * 生徒の成績を設定するクラス
5 */
6class StudentGrader
7{
8    /**
9     * 点数に基づいて成績を設定します。
10     * 点数が有効な範囲（0～100）にない場合、RangeException をスローします。
11     *
12     * @param int $score 点数
13     * @return string 成績
14     * @throws RangeException 点数が0未満または100を超える場合
15     */
16    public function setGrade(int $score): string
17    {
18        // 点数が有効範囲外かチェック
19        if ($score < 0 || $score > 100) {
20            // RangeExceptionのコンストラクタを呼び出して例外インスタンスを生成し、スローする
21            // __construct(string $message, int $code)
22            throw new RangeException('点数は0から100の範囲で指定してください。', 101);
23        }
24
25        if ($score >= 80) {
26            return 'A';
27        } elseif ($score >= 60) {
28            return 'B';
29        } else {
30            return 'C';
31        }
32    }
33}
34
35$grader = new StudentGrader();
36
37// 例1: 有効な範囲の値を渡す
38try {
39    $grade = $grader->setGrade(95);
40    echo "点数95の成績: {$grade}" . PHP_EOL;
41} catch (RangeException $e) {
42    // このブロックは実行されない
43    echo "エラー: " . $e->getMessage() . PHP_EOL;
44}
45
46echo "--------------------" . PHP_EOL;
47
48// 例2: 無効な範囲の値を渡し、例外をキャッチする
49try {
50    // 無効な値（101）を渡して、意図的に例外を発生させる
51    $grader->setGrade(101);
52} catch (RangeException $e) {
53    // スローされた例外をキャッチし、コンストラクタで設定した情報を取得する
54    echo "例外がキャッチされました！" . PHP_EOL;
55    echo "メッセージ: " . $e->getMessage() . PHP_EOL; // __constructの$message引数
56    echo "エラーコード: " . $e->getCode() . PHP_EOL;    // __constructの$code引数
57    echo "ファイル: " . $e->getFile() . PHP_EOL;
58    echo "行番号: " . $e->getLine() . PHP_EOL;
59}

RangeException::__constructは、RangeExceptionクラスのインスタンスを生成するためのコンストラクタです。コンストラクタは、クラスから新しいオブジェクトが作られる際に呼び出される特別なメソッドで、そのオブジェクトの初期設定を行います。RangeExceptionは、プログラム中の値が期待される有効範囲を超えた場合に発生させる例外です。

このコンストラクタには3つの引数があります。第一引数の$messageは、なぜ例外が発生したのかを説明するエラーメッセージを文字列で設定します。第二引数の$codeは、エラーの種類を識別するための整数コードです。第三引数の$previousは、例外が連鎖する場合に使いますが、通常は省略可能です。コンストラクタはオブジェクトを初期化する役割を持つため、戻り値はありません。

サンプルコードでは、生徒の点数が0未満または100を超える場合に、new RangeException()を呼び出して例外オブジェクトを生成し、throwキーワードで意図的に例外を発生させています。catchブロックでは、その例外を捕捉し、コンストラクタに渡されたメッセージとエラーコードを、それぞれgetMessage()メソッドとgetCode()メソッドを使って取得・表示しています。これにより、エラー発生時にその原因を具体的に知ることができます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたパーセンテージが有効な範囲内にあるか検証します。
7 *
8 * @param int $percentage 検証するパーセンテージ (0〜100)
9 * @throws RangeException パーセンテージが0未満または100より大きい場合にスローされます。
10 */
11function validatePercentage(int $percentage): void
12{
13    // パーセンテージが有効な範囲 (0〜100) にない場合
14    if ($percentage < 0 || $percentage > 100) {
15        // RangeExceptionのコンストラクタを使用して例外オブジェクトを生成し、スローします。
16        // 第1引数: エラーメッセージ (string)
17        // 第2引数: エラーコード (int)
18        throw new RangeException(
19            "パーセンテージは0から100の間でなければなりません。指定された値: {$percentage}",
20            1001
21        );
22    }
23
24    echo "パーセンテージ '{$percentage}%' は有効です。" . PHP_EOL;
25}
26
27try {
28    // 正常な値を渡して関数を呼び出す
29    validatePercentage(75);
30
31    // 不正な値（範囲外）を渡して関数を呼び出す
32    validatePercentage(120);
33} catch (RangeException $e) {
34    // スローされたRangeExceptionをキャッチします。
35    // コンストラクタで設定したメッセージとコードを取得して表示します。
36    echo "エラーが発生しました！" . PHP_EOL;
37    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
38    echo "コード: " . $e->getCode() . PHP_EOL;
39}

RangeExceptionのコンストラクタ__constructは、値が有効な範囲外であることを示す例外オブジェクトを生成する際に使用されます。このメソッドは、new RangeException()のように新しいオブジェクトが作成されるときに自動的に呼び出されます。戻り値はなく、オブジェクトのプロパティを初期化する役割を担います。

サンプルコードでは、validatePercentage関数が引数のパーセンテージを検証します。値が0から100の範囲外だった場合、new RangeException()を用いて例外オブジェクトを生成し、throwキーワードで処理を中断して例外を発生させます。

コンストラクタの第1引数$messageには、「パーセンテージは0から100の間でなければなりません...」という、エラーの詳細を説明する文字列を渡しています。第2引数$codeには、エラーの種類を識別するための数値として1001を指定しています。第3引数の$previousはこのコードでは使用されていません。

try...catchブロックによって、発生した例外が捕捉されます。catchブロック内では、$e->getMessage()と$e->getCode()メソッドを呼び出すことで、コンストラクタで設定したエラーメッセージとエラーコードをそれぞれ取得して表示できます。このように、具体的なエラー情報を設定した例外を生成することで、プログラムの問題を特定しやすくなります。