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

Copy
1<?php
2
3/**
4 * このクラスは、PHP 8で導入されたコンストラクタプロパティプロモーションの例を示します。
5 * コンストラクタの引数にアクセス修飾子（public, protected, private）を付けることで、
6 * 自動的に同名のプロパティが宣言され、初期化されます。
7 * また、コンストラクタ内で引数の値が不正な場合にValueErrorをスローする例も示します。
8 */
9class Product
10{
11    /**
12     * コンストラクタプロパティプロモーションを使用。
13     * private string $name;
14     * private float $price;
15     * というプロパティ宣言と、$this->name = $name; のような代入が省略されます。
16     *
17     * @param string $name 商品名
18     * @param float $price 価格
19     * @param int $stock 在庫数
20     * @throws ValueError 引数の値が不正な場合にスローされます。
21     */
22    public function __construct(
23        private string $name,
24        private float $price,
25        private int $stock = 0 // デフォルト値も設定可能
26    ) {
27        // コンストラクタ内で引数のバリデーション（値の検証）を行います。
28        // 引数の値が不正な場合はValueErrorをスローするのが適切です。
29        // ValueError::__construct(string $message = '', int $code = 0, ?Throwable $previous = null)
30        // 引数: メッセージ、エラーコード、前の例外（オプション）
31        if (empty($this->name)) {
32            throw new ValueError("商品名は空であってはなりません。", 1001);
33        }
34
35        if ($this->price <= 0) {
36            throw new ValueError("価格は正の数である必要があります。", 1002);
37        }
38
39        if ($this->stock < 0) {
40            throw new ValueError("在庫数は負の値であってはなりません。", 1003);
41        }
42    }
43
44    /**
45     * 商品名を取得します。
46     * @return string
47     */
48    public function getName(): string
49    {
50        return $this->name;
51    }
52
53    /**
54     * 価格を取得します。
55     * @return float
56     */
57    public function getPrice(): float
58    {
59        return $this->price;
60    }
61
62    /**
63     * 在庫数を取得します。
64     * @return int
65     */
66    public function getStock(): int
67    {
68        return $this->stock;
69    }
70}
71
72// --- 使用例 ---
73
74echo "--- 有効な商品の作成 ---" . PHP_EOL;
75try {
76    $product1 = new Product("高機能マウス", 2500.50, 100);
77    echo "商品名: " . $product1->getName() . ", 価格: " . $product1->getPrice() . ", 在庫: " . $product1->getStock() . PHP_EOL;
78} catch (ValueError $e) {
79    echo "エラー: " . $e->getMessage() . " (コード: " . $e->getCode() . ")" . PHP_EOL;
80}
81
82echo PHP_EOL . "--- 不正な商品名の場合 (ValueError発生) ---" . PHP_EOL;
83try {
84    $product2 = new Product("", 1000, 50); // 商品名が空
85    echo "商品名: " . $product2->getName() . ", 価格: " . $product2->getPrice() . ", 在庫: " . $product2->getStock() . PHP_EOL;
86} catch (ValueError $e) {
87    echo "エラー: " . $e->getMessage() . " (コード: " . $e->getCode() . ")" . PHP_EOL;
88}
89
90echo PHP_EOL . "--- 不正な価格の場合 (ValueError発生) ---" . PHP_EOL;
91try {
92    $product3 = new Product("キーボード", -500.00, 30); // 価格が負の値
93    echo "商品名: " . $product3->getName() . ", 価格: " . $product3->getPrice() . ", 在庫: " . $product3->getStock() . PHP_EOL;
94} catch (ValueError $e) {
95    echo "エラー: " . $e->getMessage() . " (コード: " . $e->getCode() . ")" . PHP_EOL;
96}
97
98echo PHP_EOL . "--- 不正な在庫数の場合 (ValueError発生) ---" . PHP_EOL;
99try {
100    $product4 = new Product("モニター", 15000.00, -10); // 在庫数が負の値
101    echo "商品名: " . $product4->getName() . ", 価格: " . $product4->getPrice() . ", 在庫: " . $product4->getStock() . PHP_EOL;
102} catch (ValueError $e) {
103    echo "エラー: " . $e->getMessage() . " (コード: " . $e->getCode() . ")" . PHP_EOL;
104}

このサンプルコードは、PHP 8で導入された「コンストラクタプロパティプロモーション」と、「ValueError例外」の使用方法を組み合わせて示しています。

Productクラスの__constructメソッドでは、引数にprivateなどのアクセス修飾子を付けることで、同名のプロパティが自動的に宣言され、引数の値で初期化されます。これにより、クラスのプロパティ定義と初期化のコード記述を簡略化し、クラス定義をより簡潔に保ちます。

コンストラクタの内部では、受け取った引数の値が適切かどうかを検証（バリデーション）しています。例えば、商品名が空だったり、価格や在庫数が不正な値（負の数など）だったりする場合には、ValueError例外をスローします。ValueErrorのコンストラクタは、string $messageで詳細なエラーメッセージ、int $codeでエラーを識別するためのコード、?Throwable $previousで前に発生した例外を引数に取ることができます。コンストラクタ自体はオブジェクトの初期化を行うため、明示的な戻り値はありません。

これにより、システムエンジニアは不適切な値がプログラムに渡されることを防ぎ、問題発生時に明確なエラー情報を提供できます。サンプルコードの下部では、try-catchブロックを使用して、Productオブジェクトの有効な作成例と、不正な値が渡された際にValueErrorを捕捉し、エラーメッセージとコードを表示する例を示しています。

Copy
1<?php
2
3/**
4 * カスタムのValueErrorクラスを定義します。
5 * このクラスはPHPの組み込みValueErrorを拡張し、
6 * コンストラクタで親クラスの初期化メソッドを呼び出します。
7 */
8class CustomInputError extends ValueError
9{
10    /**
11     * CustomInputErrorのコンストラクタ。
12     * 親クラスであるValueErrorのコンストラクタと同じ引数を持ち、
13     * それらの引数を親クラスに渡して初期化を行います。
14     *
15     * @param string $message エラーメッセージ
16     * @param int $code エラーコード
17     * @param ?Throwable $previous 以前のThrowableオブジェクト (スタックトレース用)
18     */
19    public function __construct(string $message = "無効な入力データが検出されました。", int $code = 0, ?Throwable $previous = null)
20    {
21        // 親クラス (ValueError) のコンストラクタを呼び出します。
22        // これにより、メッセージ、コード、前の例外が適切に設定され、
23        // 例外オブジェクトとして正しく機能するようになります。
24        parent::__construct($message, $code, $previous);
25    }
26}
27
28/**
29 * ユーザーが入力した数値を検証する関数。
30 * 負の数値が入力された場合、CustomInputErrorをスローします。
31 */
32function processUserNumber(int $number): void
33{
34    if ($number < 0) {
35        // カスタムエラーをスローします。
36        // ここで指定するメッセージやコードは、CustomInputErrorのコンストラクタを経て、
37        // 最終的にValueErrorのコンストラクタに渡されます。
38        throw new CustomInputError("数値はゼロ以上でなければなりません。提供された値: {$number}", 1001);
39    }
40    echo "入力された数値 {$number} は有効です。\n";
41}
42
43// 関数の実行とエラーの捕捉の例
44try {
45    processUserNumber(5);    // 正常なケース
46    processUserNumber(-10);  // エラーが発生するケース
47    processUserNumber(20);   // この行は到達しません
48} catch (CustomInputError $e) {
49    // CustomInputErrorを捕捉し、メッセージとコードを表示します。
50    echo "捕捉されたカスタムエラー: " . $e->getMessage() . " (コード: " . $e->getCode() . ")\n";
51} catch (ValueError $e) {
52    // 万が一、直接ValueErrorがスローされた場合のフォールバック。
53    // CustomInputErrorはValueErrorを継承しているため、通常はこのブロックには入りません。
54    echo "捕捉された標準ValueError: " . $e->getMessage() . " (コード: " . $e->getCode() . ")\n";
55} catch (Throwable $e) {
56    // その他の予期せぬエラーを捕捉します。
57    echo "予期せぬエラー: " . $e->getMessage() . "\n";
58}
59
60echo "\nプログラムは続行されます。\n";
61
62?>

PHPのValueErrorクラスの__constructメソッドは、このエラーオブジェクトが新しく生成される際に一度だけ呼び出される特別な初期化メソッドです。このメソッドは、ValueErrorのインスタンスがどのようなエラー情報を持つべきかを決定します。

サンプルコードでは、ValueErrorを継承したCustomInputErrorという独自の例外クラスを作成し、そのコンストラクタ内でparent::__construct()を呼び出しています。これは、親クラスであるValueErrorの初期化処理を明示的に実行することで、ValueErrorが持つ基本的なエラー情報の設定を確実に引き継ぐために重要です。

引数$messageにはエラー内容を表す文字列を、$codeにはエラーを識別するための任意の整数値を指定します。また、$previousには、現在のエラーを引き起こした可能性のある別の例外オブジェクトを渡すことができ、エラーの連鎖を追跡するのに役立ちます（この引数は省略可能です）。__constructメソッドはオブジェクトの初期設定を行うため、値を返しません。このようにparent::__construct()を利用することで、基本的なエラー処理の仕組みを保ちながら、独自の具体的なエラーに対応したカスタム例外を作成できます。

Copy
1<?php
2
3/**
4 * 正の整数を処理する関数。
5 * 入力値が正の整数でない場合、ValueErrorをスローします。
6 *
7 * @param int $number 処理する数値
8 * @return string 処理結果メッセージ
9 * @throws ValueError 引数が正の整数でない場合
10 */
11function processPositiveNumber(int $number): string
12{
13    // 数値が正の整数であるかチェック
14    if ($number <= 0) {
15        // ValueErrorのコンストラクタ(__construct)を使用して新しい例外インスタンスを生成
16        // 引数: エラーメッセージ (string), エラーコード (int)
17        throw new ValueError("数値は正の整数である必要があります。受け取った値: " . $number, 1001);
18    }
19
20    return "正の整数 " . $number . " が正常に処理されました。";
21}
22
23// 例1: 正常な処理の実行
24try {
25    echo processPositiveNumber(5) . PHP_EOL;
26} catch (ValueError $e) {
27    echo "エラーが発生しました: " . $e->getMessage() . " (コード: " . $e->getCode() . ")" . PHP_EOL;
28}
29
30// 例2: ValueErrorがスローされるケースの実行
31try {
32    echo processPositiveNumber(-3) . PHP_EOL; // ここでValueErrorがスローされる
33} catch (ValueError $e) {
34    // スローされたValueErrorを捕捉し、メッセージとコードを表示
35    echo "エラーが発生しました: " . $e->getMessage() . " (コード: " . $e->getCode() . ")" . PHP_EOL;
36}
37
38// 例3: ゼロが渡された場合
39try {
40    echo processPositiveNumber(0) . PHP_EOL; // ここでもValueErrorがスローされる
41} catch (ValueError $e) {
42    echo "エラーが発生しました: " . $e->getMessage() . " (コード: " . $e->getCode() . ")" . PHP_EOL;
43}
44
45?>

PHP 8以降で導入されたValueErrorは、関数やメソッドに渡された引数の型は正しいものの、その「値」が期待する範囲外である場合に発生するエラーを示すためのクラスです。このValueErrorインスタンスを作成する際に使われるのが、__constructメソッドです。

__constructメソッドは、新しいValueErrorオブジェクトを初期化します。引数には、エラーの詳細を記述する文字列型の$messageと、エラーの種類を識別するための整数型の$codeを指定できます。これらはエラー発生時に具体的な情報を提供するために非常に重要です。また、オプションで、この例外の前に発生した別のThrowableオブジェクトを$previousとして渡すことも可能ですが、省略できます。このメソッド自体は、値を直接返しませんが、実行されることで設定された情報を持つValueErrorインスタンスが生成されます。

サンプルコードでは、processPositiveNumber関数が正の整数以外を受け取った場合に、throw new ValueError(...)と記述することで、この__constructメソッドを使って「数値は正の整数である必要があります。」というメッセージとエラーコード1001を持つValueErrorインスタンスを生成し、それをスローしています。呼び出し元のtry-catchブロックでは、スローされたValueErrorを捕捉し、getMessage()やgetCode()メソッドで設定されたエラー情報を取得し、表示しています。これにより、プログラムが異常終了するのを防ぎ、エラーの詳細を適切に処理できます。

Copy
1<?php
2
3/**
4 * ValueError クラスのコンストラクタ(__construct)の使用方法をデモンストレーションするクラスです。
5 * ValueError は、引数の値が不正な場合にスローされるエラーです（PHP 8以降）。
6 * このクラスは、システムエンジニアを目指す初心者向けに、ValueError の生成と捕捉の方法を示します。
7 */
8class ValueErrorDemonstrator
9{
10    /**
11     * 数値が正の数であることを要求し、そうでない場合に ValueError をスローします。
12     * このメソッドは ValueError のメッセージとコード引数の使用例を示します。
13     *
14     * @param int $number 処理する数値
15     * @throws ValueError 数値が正の数でない場合にスローされます。
16     */
17    public function requirePositiveNumber(int $number): void
18    {
19        // 引数の値がビジネスロジック的に不正であるかをチェック
20        if ($number <= 0) {
21            // new ValueError(...) は、ValueError クラスのコンストラクタ(__construct)を呼び出しています。
22            // __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
23            // 第一引数: エラーメッセージ
24            // 第二引数: エラーコード (オプション)
25            throw new ValueError("正の数値が必要です。受け取った値: " . $number, 101);
26        }
27        echo "成功: 数値 " . $number . " を処理しました。" . PHP_EOL;
28    }
29
30    /**
31     * 別の例外を捕捉し、それを原因とする ValueError をスローする例を示します。
32     * このメソッドは ValueError の全てのコンストラクタ引数（メッセージ、コード、前の例外）の使用例を示します。
33     *
34     * @param string $input 検証する文字列
35     * @throws ValueError 入力値が不正な場合にスローされます。
36     */
37    public function processWithWrappedError(string $input): void
38    {
39        try {
40            // 何らかの処理で別の例外が発生したと仮定します。
41            // 例えば、外部ライブラリが InvalidArgumentException をスローする場合など。
42            if (empty($input)) {
43                throw new InvalidArgumentException("入力文字列は空にできません。");
44            }
45            echo "成功: 入力 '" . $input . "' を処理しました。" . PHP_EOL;
46        } catch (InvalidArgumentException $previousException) {
47            // 捕捉した既存の例外 ($previousException) を原因として、
48            // 新しい ValueError をスローします。
49            // __construct の第三引数 ($previous) に、前の例外を渡します。
50            throw new ValueError(
51                "入力値の検証に失敗しました。", // 新しいエラーメッセージ
52                201,                           // エラーコード
53                $previousException             // 前の例外（原因）
54            );
55        }
56    }
57
58    /**
59     * ValueError の生成と捕捉のデモンストレーションを実行します。
60     */
61    public function runDemonstration(): void
62    {
63        echo "--- シナリオ1: 不正な引数で ValueError をスロー ---" . PHP_EOL;
64        try {
65            $this->requirePositiveNumber(10);  // 成功するケース
66            $this->requirePositiveNumber(-5); // ValueError がスローされるケース
67        } catch (ValueError $e) {
68            // ValueError を捕捉し、メッセージとコードを表示
69            echo "捕捉した ValueError:" . PHP_EOL;
70            echo "  メッセージ: " . $e->getMessage() . PHP_EOL;
71            echo "  コード: " . $e->getCode() . PHP_EOL;
72            // このシナリオでは、前の例外は設定されていないため null です。
73            if ($e->getPrevious()) {
74                echo "  前の例外: " . $e->getPrevious()->getMessage() . PHP_EOL;
75            }
76        } catch (Throwable $e) {
77            // その他の予期せぬ例外を捕捉
78            echo "捕捉した予期せぬ例外: " . $e->getMessage() . PHP_EOL;
79        }
80
81        echo PHP_EOL; // 区切り
82
83        echo "--- シナリオ2: 別の例外をラップした ValueError をスロー ---" . PHP_EOL;
84        try {
85            $this->processWithWrappedError("Hello"); // 成功するケース
86            $this->processWithWrappedError("");      // ValueError (ラップされたもの) がスローされるケース
87        } catch (ValueError $e) {
88            // ラップされた ValueError を捕捉
89            echo "捕捉した ValueError (ラップ済み):" . PHP_EOL;
90            echo "  メッセージ: " . $e->getMessage() . PHP_EOL;
91            echo "  コード: " . $e->getCode() . PHP_EOL;
92            // 前の例外が存在する場合、それを取得して詳細を表示できます。
93            if ($e->getPrevious()) {
94                echo "  前の例外のメッセージ: " . $e->getPrevious()->getMessage() . PHP_EOL;
95                echo "  前の例外のタイプ: " . get_class($e->getPrevious()) . PHP_EOL;
96            }
97        } catch (Throwable $e) {
98            // その他の予期せぬ例外を捕捉
99            echo "捕捉した予期せぬ例外: " . $e->getMessage() . PHP_EOL;
100        }
101    }
102}
103
104// ValueErrorDemonstrator クラスのインスタンスを作成し、デモンストレーションを実行します。
105$demonstrator = new ValueErrorDemonstrator();
106$demonstrator->runDemonstration();
107
108?>

PHP 8で導入されたValueErrorは、関数やメソッドの引数の値が、データ型としては正しいものの、ビジネスロジック上不正である場合にスローされる例外です。このサンプルコードは、そのValueErrorを生成する際のコンストラクタである__constructの使い方を、システムエンジニアを目指す初心者の方に向けて解説しています。

__constructメソッドは、新しいValueErrorオブジェクトを作成する際に呼び出され、エラーの詳細を設定するための三つの引数を取ります。第一引数の$messageには、エラーの内容を説明する文字列を指定し、例外が捕捉された際に利用されます。第二引数の$codeは、エラーを一意に識別するための数値で、システムの内部的なエラー管理に役立ちます。これはオプションであり、省略するとデフォルト値の0が設定されます。第三引数の$previousもオプションで、このValueErrorが発生する原因となった元の例外オブジェクトを指定するために使用します。これにより、複数の例外が連鎖するケースでも、エラーの根本原因を追跡しやすくなります。

サンプルコードでは、まず引数が正の数であるかをチェックし、不正な場合にメッセージとコードを指定してValueErrorをスローする例を示しています。次に、別の例外を捕捉し、それを$previous引数として新しいValueErrorを再スローすることで、エラーの根本原因を保持しつつ、ビジネスロジックに特化したエラーとして扱う方法を具体的に示しています。これらの方法により、不正な引数値に対する堅牢なエラーハンドリングを実装できます。