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

Copy
1<?php
2
3/**
4 * サンプルで使用するクラス。
5 * コンストラクタで名前と年齢を受け取ります。
6 */
7class Person
8{
9    private string $name;
10    private int $age;
11
12    /**
13     * Person クラスのコンストラクタ。
14     *
15     * @param string $name 人の名前
16     * @param int    $age  人の年齢
17     */
18    public function __construct(string $name, int $age)
19    {
20        $this->name = $name;
21        $this->age = $age;
22    }
23
24    /**
25     * 自己紹介のメッセージを返します。
26     *
27     * @return string 自己紹介の文字列
28     */
29    public function introduce(): string
30    {
31        return "こんにちは、私の名前は {$this->name} です。{$this->age} 歳です。";
32    }
33}
34
35// ReflectionClass オブジェクトを作成します。
36// これにより、クラスの構造を調べたり、動的に操作したりできます。
37$reflector = new ReflectionClass(Person::class);
38
39// newInstanceArgs メソッドに渡す引数を配列で準備します。
40// コンストラクタが期待する引数の順序で配列に格納します。
41$argsForAlice = ['アリス', 30];
42
43// ReflectionClass::newInstanceArgs() を使用して、
44// クラスの新しいインスタンスを動的に生成します。
45// このメソッドは、コンストラクタの引数を配列として渡せる点が特徴です。
46/** @var Person $alice */
47$alice = $reflector->newInstanceArgs($argsForAlice);
48
49// 生成されたインスタンスのメソッドを呼び出し、正しく初期化されたか確認します。
50echo "最初のインスタンス: " . $alice->introduce() . PHP_EOL;
51
52// 別の引数配列で再度インスタンスを生成することもできます。
53$argsForBob = ['ボブ', 25];
54/** @var Person $bob */
55$bob = $reflector->newInstanceArgs($argsForBob);
56
57echo "二番目のインスタンス: " . $bob->introduce() . PHP_EOL;
58
59?>

ReflectionClass::newInstanceArgsメソッドは、PHPのReflection APIを利用して、プログラムの実行中にクラスの新しいインスタンスを動的に生成するための機能です。このメソッドの主な特徴は、クラスのコンストラクタに渡す引数を配列として指定できる点にあります。

メソッドを呼び出す際には、引数としてコンストラクタに渡したい値を順序通りに格納した配列$argsを指定します。例えば、コンストラクタが名前と年齢を期待する場合、['山田太郎', 30]のような配列を渡します。戻り値としては、指定された引数でコンストラクタが実行され、新しく生成されたクラスのインスタンス（object型）が返されます。

サンプルコードでは、Personクラスの構造を反映するReflectionClassオブジェクトを作成し、newInstanceArgsメソッドを用いて、「アリス」や「ボブ」といった異なる引数セットでPersonクラスのインスタンスを生成しています。これにより、コードを実行する時点での情報に基づいて、柔軟かつ動的にオブジェクトを作成することが可能になります。例えば、データベースから取得した情報をもとに、適切なデータでオブジェクトを初期化するような場面でこの機能が役立ちます。

Copy
1<?php
2
3/**
4 * サンプルで使用するクラス
5 * コンストラクタで引数を受け取り、プロパティを初期化します。
6 */
7class Product
8{
9    private string $name;
10    private float $price;
11
12    /**
13     * コンストラクタ
14     * @param string $name 製品名
15     * @param float $price 価格
16     */
17    public function __construct(string $name, float $price)
18    {
19        $this->name = $name;
20        $this->price = $price;
21    }
22
23    /**
24     * 製品情報を文字列で取得します。
25     * @return string 製品情報
26     */
27    public function getInfo(): string
28    {
29        return "製品名: {$this->name}, 価格: {$this->price}円";
30    }
31}
32
33// ReflectionClass を使用して Product クラスの情報を取得します。
34// これにより、クラスの動的な操作が可能になります。
35$reflectionClass = new ReflectionClass(Product::class);
36
37// newInstanceArgs メソッドに渡す引数を配列で準備します。
38// この配列の要素が Product クラスのコンストラクタの引数として渡されます。
39$constructorArgs = ['スマートフォン', 89800.50];
40
41// newInstanceArgs を使って、引数を渡しながら Product クラスの新しいインスタンスを生成します。
42// これは 'new Product('スマートフォン', 89800.50)' と同等の操作を動的に行います。
43$productInstance = $reflectionClass->newInstanceArgs($constructorArgs);
44
45// 生成されたインスタンスが正しく動作するか確認するため、getInfo メソッドを呼び出します。
46echo $productInstance->getInfo() . PHP_EOL;
47
48// 別の引数で別のインスタンスを生成してみます。
49$anotherConstructorArgs = ['ノートPC', 120000.00];
50$anotherProductInstance = $reflectionClass->newInstanceArgs($anotherConstructorArgs);
51echo $anotherProductInstance->getInfo() . PHP_EOL;
52
53?>

PHPのReflectionClass::newInstanceArgsメソッドは、プログラムの実行中にクラスの情報を調べ、そのクラスの新しいインスタンスを動的に生成するための機能です。このメソッドは、クラスのコンストラクタに引数を渡してインスタンスを作成したい場合に特に役立ちます。

引数$argsには、生成したいクラスのコンストラクタに渡す値のリストを配列として指定します。この配列の要素は、コンストラクタの引数として順に渡されます。メソッドの戻り値は、指定された引数で初期化された、クラスの新しいインスタンス（オブジェクト）です。

通常のnewキーワードを使ってインスタンスを生成する場合、クラス名やコンストラクタの引数はコード中に固定されます。しかし、newInstanceArgsを使用することで、クラス名やコンストラクタに渡す引数を変数から動的に取得し、プログラムの状況に応じて柔軟にオブジェクトを生成することが可能になります。

サンプルコードでは、ProductクラスのReflectionClassインスタンスを作成し、newInstanceArgsメソッドに製品名と価格を含む配列を渡しています。これにより、Productクラスのコンストラクタが呼び出され、指定された値で初期化されたProductオブジェクトが生成されます。この方法は、例えば設定ファイルからクラス名や初期値を読み込んでオブジェクトを生成するような、より柔軟なシステム構築に貢献します。