【PHP8.x】__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()を利用することで、基本的なエラー処理の仕組みを保ちながら、独自の具体的なエラーに対応したカスタム例外を作成できます。