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

Copy
1<?php
2
3/**
4 * ユーザー名の長さが不正な場合にスローされる独自の例外クラス。
5 * LengthExceptionを継承し、PHP 8.0の新機能である「コンストラクタプロモーション」を利用します。
6 */
7class InvalidUsernameException extends LengthException
8{
9    /**
10     * コンストラクタ
11     *
12     * キーワード「コンストラクタプロモーション」の利用例です。
13     * 引数に `public readonly string $invalidUsername` と可視性(public)や修飾子(readonly)を付けるだけで、
14     * 同名のプロパティが自動的に宣言され、コンストラクタの引数が代入されます。
15     *
16     * 従来の書き方:
17     * public readonly string $invalidUsername;
18     * public function __construct(string $invalidUsername, ...) {
19     *     $this->invalidUsername = $invalidUsername;
20     *     parent::__construct(...);
21     * }
22     * これが1行で簡潔に記述できます。
23     *
24     * @param string $invalidUsername 検証に失敗したユーザー名。この値が同名の公開プロパティにセットされます。
25     * @param string $message 親クラスに渡す例外メッセージ。
26     * @param int $code 親クラスに渡す例外コード。
27     * @param ?Throwable $previous 親クラスに渡す直前の例外。
28     */
29    public function __construct(
30        public readonly string $invalidUsername,
31        string $message = "",
32        int $code = 0,
33        ?Throwable $previous = null
34    ) {
35        // 親クラスである LengthException のコンストラクタを呼び出します。
36        parent::__construct($message, $code, $previous);
37    }
38}
39
40/**
41 * 指定されたユーザー名の長さを検証する関数。
42 *
43 * @param string $username 検証するユーザー名。
44 * @throws InvalidUsernameException ユーザー名の長さが4文字未満または10文字より大きい場合。
45 */
46function validateUsername(string $username): void
47{
48    $length = mb_strlen($username);
49    if ($length < 4 || $length > 10) {
50        // 長さが不正な場合、カスタム例外をスローします。
51        throw new InvalidUsernameException(
52            $username, // コンストラクタプロモーションで定義されたプロパティ `$invalidUsername` に渡される値
53            "ユーザー名は4文字以上10文字以下にしてください。"
54        );
55    }
56    echo "ユーザー名 '{$username}' は有効です。" . PHP_EOL;
57}
58
59// --- メイン処理 ---
60try {
61    // わざと短すぎるユーザー名を指定して、例外を発生させます。
62    validateUsername("Joe");
63} catch (InvalidUsernameException $e) {
64    // InvalidUsernameException をキャッチします。
65    echo "エラーをキャッチしました。" . PHP_EOL;
66    // 親クラス(Exception)から継承したメソッドでメッセージを取得します。
67    echo "  メッセージ: " . $e->getMessage() . PHP_EOL;
68    // コンストラクタプロモーションによって設定された公開プロパティにアクセスします。
69    echo "  不正な入力値: " . $e->invalidUsername . PHP_EOL;
70}

LengthExceptionクラスの__constructメソッドは、このクラスのインスタンスを生成する際に自動的に呼び出されるコンストラクタです。主に、長さに関するエラーが発生した際の詳細情報であるエラーメッセージやエラーコードなどを初期化する役割を担います。

サンプルコードでは、LengthExceptionを継承してInvalidUsernameExceptionという独自の例外クラスを定義しています。これにより、「ユーザー名の長さが不正」という、より具体的なエラー状況を扱うことができます。

このコードの最大の特徴は、PHP 8の新機能「コンストラクタプロモーション」を利用している点です。コンストラクタの引数で public readonly string $invalidUsername のように可視性や型を宣言するだけで、同名のプロパティが自動的に定義され、引数の値が代入されます。これにより、従来よりもコードを大幅に簡潔に記述できます。

InvalidUsernameExceptionのコンストラクタは、不正なユーザー名を独自のプロパティに格納しつつ、parent::__construct() を呼び出して、受け取ったエラーメッセージなどを親クラスであるLengthExceptionに渡して処理を委ねています。

引数$messageはエラーメッセージ、$codeはエラーコード、$previousは例外が連鎖する場合の直前の例外オブジェクトを指定します。コンストラクタのため、このメソッドに戻り値はありません。

Copy
1<?php
2
3/**
4 * LengthExceptionを継承したカスタム例外クラスです。
5 * ユーザー名の長さが不正な場合にスローされます。
6 */
7class InvalidUsernameLengthException extends LengthException
8{
9    /**
10     * PHP 8.0の新機能「コンストラクタプロパティプロモーション」を使用しています。
11     * コンストラクタの引数に可視性(public, protected, private)を指定することで、
12     * プロパティの宣言とコンストラクタ内での値の代入を同時に行うことができます。
13     *
14     * @param string $username 検証に失敗したユーザー名
15     * @param int $minLength 許容される最小文字数
16     * @param int $maxLength 許容される最大文字数
17     * @param string $message 例外メッセージ
18     * @param int $code 例外コード
19     * @param ?Throwable $previous 前の例外
20     */
21    public function __construct(
22        public readonly string $username,
23        public readonly int $minLength,
24        public readonly int $maxLength,
25        string $message = "",
26        int $code = 0,
27        ?Throwable $previous = null
28    ) {
29        // 親クラスであるLengthExceptionのコンストラクタを呼び出します。
30        // メッセージが指定されていない場合は、ここで動的に生成します。
31        if ($message === "") {
32            $message = "ユーザー名 '{$this->username}' は{$this->minLength}〜{$this->maxLength}文字で入力してください。";
33        }
34        parent::__construct($message, $code, $previous);
35    }
36}
37
38/**
39 * ユーザー名の長さを検証し、不正な場合にカスタム例外をスローする関数です。
40 *
41 * @param string $username 検証するユーザー名
42 * @throws InvalidUsernameLengthException ユーザー名の長さが不正な場合
43 */
44function validateUsernameLength(string $username): void
45{
46    $minLength = 4;
47    $maxLength = 16;
48    $actualLength = mb_strlen($username);
49
50    if ($actualLength < $minLength || $actualLength > $maxLength) {
51        // 長さが不正な場合、カスタム例外をスローします。
52        // コンストラクタプロパティプロモーションにより、引数を渡すだけでプロパティが初期化されます。
53        throw new InvalidUsernameLengthException($username, $minLength, $maxLength);
54    }
55
56    echo "ユーザー名 '{$username}' は有効です。" . PHP_EOL;
57}
58
59// --- 実行コード ---
60try {
61    validateUsernameLength('php_developer'); // 正常なケース
62    validateUsernameLength('ng');            // 例外がスローされるケース
63} catch (InvalidUsernameLengthException $e) {
64    // スローされたカスタム例外をキャッチします。
65    echo "エラー: " . $e->getMessage() . PHP_EOL;
66    // カスタム例外クラスで定義したプロパティに直接アクセスできます。
67    echo "入力されたユーザー名: " . $e->username . PHP_EOL;
68    echo "許容文字数: " . $e->minLength . "〜" . $e->maxLength . "文字" . PHP_EOL;
69}

このサンプルコードは、PHPの組み込み例外クラスLengthExceptionを継承し、ユーザー名の文字数検証に特化した独自の例外クラスInvalidUsernameLengthExceptionを定義する例です。

LengthExceptionのコンストラクタ__constructは、例外に関する情報として、エラーメッセージの$message、エラーコードの$code、そして直前の例外を示す$previousを引数に取ります。

このカスタム例外クラスでは、PHP 8.0の新機能「コンストラクタプロパティプロモーション」が活用されています。コンストラクタの引数にpublic readonlyのようなアクセス修飾子を付けることで、クラスのプロパティ宣言と、コンストラクタ内での値の代入を同時に、かつ簡潔に記述できます。これにより、検証に失敗したユーザー名などの追加情報を、例外オブジェクトが直接保持できるようになります。

クラス内部では、parent::__construct()を呼び出すことで親クラスであるLengthExceptionのコンストラクタを実行し、例外としての基本的な機能を初期化しています。コンストラクタはオブジェクトを初期化するための特別なメソッドであり、戻り値はありません。この仕組みにより、エラー発生時に、より具体的で詳細な情報を含んだ例外をスローすることが可能になります。