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

Copy
1<?php
2
3/**
4 * ユーザー入力が期待しない値だった場合にスローされる、独自の例外クラスを定義します。
5 * PHPに組み込まれている UnexpectedValueException を継承しています。
6 */
7class InvalidUserInputException extends UnexpectedValueException
8{
9    /**
10     * このクラスのコンストラクタです。
11     * オブジェクトが `new` キーワードで生成される際に自動的に呼び出されます。
12     *
13     * @param string $message エラーメッセージ
14     * @param int $code エラーコード
15     * @param ?Throwable $previous 直前の例外（例外チェーン用）
16     */
17    public function __construct(string $message = "", int $code = 0, ?Throwable $previous = null)
18    {
19        // 親クラスである UnexpectedValueException のコンストラクタを呼び出し、
20        // 例外の基本的な情報を設定します。
21        parent::__construct($message, $code, $previous);
22    }
23}
24
25/**
26 * ユーザーIDを検証する関数。
27 *
28 * @param mixed $userId 検証するユーザーID
29 * @return void
30 * @throws InvalidUserInputException ユーザーIDが正の整数でない場合にスローされる
31 */
32function validateUserId(mixed $userId): void
33{
34    // is_int()で整数かどうか、かつ正の数であるかを確認します。
35    if (!is_int($userId) || $userId <= 0) {
36        // 条件を満たさない場合、InvalidUserInputException のコンストラクタを呼び出して
37        // 例外オブジェクトを生成し、`throw`キーワードでスロー（送出）します。
38        throw new InvalidUserInputException("ユーザーIDは正の整数である必要があります。");
39    }
40
41    echo "ユーザーID '{$userId}' は有効です。" . PHP_EOL;
42}
43
44// try-catchブロックを使用して、例外が発生する可能性のある処理を実行します。
45try {
46    // 正常なケース
47    validateUserId(123);
48
49    // 意図的に例外を発生させるケース
50    validateUserId('user-abc');
51
52} catch (InvalidUserInputException $e) {
53    // InvalidUserInputException 型の例外がスローされた場合に、このブロックが実行されます。
54    // getMessage() メソッドでコンストラクタに渡したエラーメッセージを取得できます。
55    echo 'エラー: ' . $e->getMessage() . PHP_EOL;
56}

PHPのUnexpectedValueException::__constructは、UnexpectedValueExceptionクラスの新しいインスタンス（オブジェクト）を生成するためのコンストラクタです。コンストラクタは、newキーワードを使ってオブジェクトが生成される際に自動的に呼び出される特別なメソッドです。

このメソッドには3つの引数があります。第一引数の$messageは、例外が発生した理由を示すエラーメッセージの文字列です。第二引数の$codeは、エラーの種類を識別するための整数値（エラーコード）です。第三引数の$previousは、ある例外が別の例外を引き起こした場合に、元の例外オブジェクトを関連付ける「例外チェーン」のために使用します。これらの引数はすべて任意です。コンストラクタ自体に戻り値はありません。

サンプルコードでは、まずUnexpectedValueExceptionを継承したInvalidUserInputExceptionという独自の例外クラスを定義しています。validateUserId関数の中で、ユーザーIDが不正な値（正の整数でない）の場合にnew InvalidUserInputException("ユーザーIDは正の整数である必要があります。")という形でコンストラクタを呼び出しています。これにより、$messageに指定した文字列がセットされた例外オブジェクトが生成され、throwキーワードで送出されます。最終的にcatchブロックでこの例外オブジェクトが捕捉され、getMessage()メソッドを通じてコンストラクタに渡されたメッセージが表示されます。このように、コンストラクタは例外オブジェクトに具体的なエラー情報を設定する役割を担います。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ユーザーIDを検証し、数値でなければUnexpectedValueExceptionをスローする関数
7 *
8 * @param mixed $userId 検証するユーザーID
9 * @return void
10 * @throws UnexpectedValueException ユーザーIDが数値でない場合
11 */
12function validateUserId(mixed $userId): void
13{
14    if (!is_numeric($userId)) {
15        // UnexpectedValueExceptionのコンストラクタを呼び出し、例外オブジェクトを生成してスローする
16        // 第1引数: エラーメッセージ
17        // 第2引数: エラーコード
18        throw new UnexpectedValueException('ユーザーIDは数値である必要があります。', 1001);
19    }
20
21    echo "ユーザーID '{$userId}' は有効です。" . PHP_EOL;
22}
23
24// 例外処理のブロック
25try {
26    // 正常なケース
27    validateUserId(123);
28
29    // 例外が発生するケース
30    validateUserId('abc');
31} catch (UnexpectedValueException $e) {
32    // catchブロックでスローされた例外を捕捉する
33    echo 'エラーが発生しました。' . PHP_EOL;
34    // getMessage() でコンストラクタに渡したメッセージを取得
35    echo 'メッセージ: ' . $e->getMessage() . PHP_EOL;
36    // getCode() でコンストラクタに渡したコードを取得
37    echo 'エラーコード: ' . $e->getCode() . PHP_EOL;
38}

このサンプルコードは、UnexpectedValueExceptionクラスのコンストラクタ__constructメソッドの使用方法を示しています。コンストラクタは、newキーワードを使ってクラスの新しいインスタンス（オブジェクト）を生成する際に自動的に呼び出され、そのオブジェクトを初期化する役割を持ちます。

コード内のvalidateUserId関数では、引数が数値でない場合にthrow new UnexpectedValueException(...)として例外を発生させています。このnewが使われる部分で、__constructが実行されます。

__constructメソッドは、最大3つの引数を取ります。第1引数の$messageには、エラーの具体的な内容を示す文字列（この例では「ユーザーIDは数値である必要があります。」）を設定します。第2引数の$codeには、エラーの種類を識別するための整数値（この例では1001）を設定します。第3引数の$previousは、例外が連鎖した場合に、直前の例外オブジェクトを指定するために使いますが、この例では省略されています。

スローされた例外はcatchブロックで捕捉され、$e->getMessage()や$e->getCode()といったメソッドを通じて、コンストラクタで設定したエラーメッセージやエラーコードを取得できます。このように、__constructは、発生したエラーの詳細情報を例外オブジェクトに格納するために不可欠なメソッドです。