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

Copy
1<?php
2
3/**
4 * ArgumentCountError を発生させる例
5 */
6class MyClass
7{
8    public function __construct(public string $name, public int $age)
9    {
10        // property promotion を使用しているので、
11        // ここで改めてプロパティを定義する必要はありません。
12        // 例：$this->name = $name; // これは不要
13    }
14
15    public function greet(): void
16    {
17        echo "Hello, my name is " . $this->name . " and I am " . $this->age . " years old.\n";
18    }
19}
20
21try {
22    // 引数の数が足りないため、ArgumentCountError が発生します
23    $obj = new MyClass("Alice");
24    $obj->greet();
25} catch (ArgumentCountError $e) {
26    echo "ArgumentCountError caught: " . $e->getMessage() . "\n";
27}
28
29// 引数の数を正しく指定した場合
30$obj2 = new MyClass("Bob", 30);
31$obj2->greet();

PHP 8におけるArgumentCountErrorクラスのコンストラクタ__constructメソッドについて解説します。このコンストラクタは、引数の数が不足している場合に発生するArgumentCountErrorオブジェクトを初期化するために使用されます。

コンストラクタは、オプションで以下の3つの引数を受け取ります。$messageはエラーメッセージを指定する文字列、$codeはエラーコードを指定する整数、$previousは以前のスローされたThrowableオブジェクトを指定します。これらはそれぞれエラーに関する詳細情報を提供するために使用されます。

サンプルコードでは、MyClassというクラスを定義し、コンストラクタでproperty promotionというPHP 8の機能を利用しています。これにより、コンストラクタの引数として渡された値が、自動的にクラスのプロパティとして定義され、初期化されます。

try-catchブロックの中で、MyClassのインスタンスを生成する際に、必要な引数（nameとage）のうち、nameのみを渡しています。この結果、コンストラクタに渡す引数の数が不足するため、ArgumentCountErrorが発生します。catchブロックでは、このエラーを捕捉し、エラーメッセージを出力します。

その後、引数の数を正しく指定してMyClassのインスタンスを生成し、greetメソッドを呼び出すことで、正常に動作することを確認しています。このサンプルコードは、ArgumentCountErrorがどのように発生し、どのように捕捉できるかを示す良い例です。

Copy
1<?php
2
3class CustomException extends Exception
4{
5    public function __construct(string $message = "", int $code = 0, ?Throwable $previous = null)
6    {
7        // 親クラスのコンストラクタを呼び出す。
8        parent::__construct($message, $code, $previous);
9    }
10
11    public function __toString(): string
12    {
13        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
14    }
15}
16
17try {
18    throw new CustomException("カスタム例外が発生しました。", 100);
19} catch (CustomException $e) {
20    echo $e;
21}

このPHPのサンプルコードは、ArgumentCountErrorクラスのコンストラクタ__constructの利用例を示すものではなく、例外処理をカスタム例外クラスで行う方法を示しています。ArgumentCountErrorは引数の数が間違っている場合に自動的に投げられる例外であり、直接コンストラクタを呼び出すことは通常ありません。

この例では、まずCustomExceptionというカスタム例外クラスを定義しています。このクラスは、標準のExceptionクラスを継承しており、独自の例外処理を実装できます。__constructメソッドは、例外発生時に呼び出されるコンストラクタです。引数として、例外メッセージ $message（文字列）、例外コード $code（整数）、そして前の例外 $previous（Throwableオブジェクトまたはnull）を受け取ります。これらの引数は、例外に関する詳細情報を提供するために使用されます。デフォルト値を設定することで、引数を省略することも可能です。

parent::__construct($message, $code, $previous); の部分は、親クラスである Exception クラスのコンストラクタを呼び出しています。これは、カスタム例外クラスが親クラスの基本的な例外処理機能も利用できるようにするために重要です。

__toStringメソッドは、例外オブジェクトを文字列として表現する方法を定義しています。ここでは、クラス名、例外コード、メッセージを組み合わせて文字列を生成しています。

try-catchブロックは、例外が発生する可能性のあるコードを囲み、例外が発生した場合の処理を記述します。この例では、CustomExceptionを throw で発生させ、catch ブロックでそれを捕捉して、__toStringメソッドを使って例外情報を出力しています。