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

Copy
1<?php
2
3/**
4 * リフレクションAPIを使ってインスタンスを生成する対象となるサンプルクラス。
5 * コンストラクタで引数を受け取ります。
6 */
7class MyClass
8{
9    private string $name;
10    private int $age;
11
12    /**
13     * コンストラクタ
14     * @param string $name 名前
15     * @param int $age 年齢
16     */
17    public function __construct(string $name, int $age)
18    {
19        $this->name = $name;
20        $this->age = $age;
21        echo "MyClassのインスタンスが作成されました: 名前={$this->name}, 年齢={$this->age}\n";
22    }
23
24    /**
25     * プロパティの値を表示するメソッド
26     */
27    public function displayInfo(): void
28    {
29        echo "情報表示: 名前: {$this->name}, 年齢: {$this->age}\n";
30    }
31}
32
33// ReflectionClass を使ってMyClassの情報を取得します。
34// これにより、クラスの構造を動的に調べたり、インスタンスを生成したりできます。
35$reflector = new ReflectionClass(MyClass::class);
36
37echo "--- ReflectionClass::newInstance() の使用例 (引数を直接渡す) ---\n";
38
39// newInstance() メソッドを使って、MyClassの新しいインスタンスを生成します。
40// 引数は直接メソッドに渡します。
41$instance1 = $reflector->newInstance('Alice', 30);
42
43// 生成されたインスタンスのメソッドを呼び出して確認します。
44$instance1->displayInfo();
45echo "\n";
46
47
48echo "--- ReflectionClass::newInstance() の使用例 (配列の引数を展開して渡す) ---\n";
49
50// PHP 8では ReflectionClass::newInstanceArgs() は削除され、
51// ReflectionClass::newInstance() が可変長引数に対応しました。
52// 以前 newInstanceArgs() が行っていた「引数を配列で渡す」機能は、
53// newInstance() に配列をスプレッド演算子 (...) で展開して渡すことで実現できます。
54$constructorArgs = ['Bob', 25];
55
56// newInstance() メソッドに、配列をスプレッド演算子 (...) で展開して渡します。
57// これは newInstanceArgs() を使用していた場合と同様の挙動になります。
58$instance2 = $reflector->newInstance(...$constructorArgs);
59
60// 生成されたインスタンスのメソッドを呼び出して確認します。
61$instance2->displayInfo();
62echo "\n";
63
64echo "--- 補足: 引数なしのクラスのインスタンス化 ---\n";
65
66class SimpleClass
67{
68    public function __construct()
69    {
70        echo "SimpleClassのインスタンスが作成されました。\n";
71    }
72}
73
74$simpleReflector = new ReflectionClass(SimpleClass::class);
75$simpleInstance = $simpleReflector->newInstance();
76
77?>

PHPのReflectionClass::newInstanceメソッドは、プログラムの実行中にクラスの情報を動的に取得・操作できるReflectionClassオブジェクトを用いて、そのクラスの新しいインスタンスを生成するための機能です。

このメソッドはmixed ...$argsという可変長引数を取ります。これは、インスタンスを生成するクラスのコンストラクタが必要とする引数を、直接指定して渡すことができることを意味します。複数の引数を順番に指定して渡すことが可能です。

PHP 8以降では、以前のバージョンに存在したnewInstanceArgs()メソッドは削除されました。そのため、もしコンストラクタに渡したい引数が配列で準備されている場合は、newInstance()メソッドにスプレッド演算子（...）を使ってその配列を展開して渡すことで、かつてのnewInstanceArgs()と同様に配列の引数を渡す挙動を実現できます。

newInstanceメソッドは、指定された引数でクラスのコンストラクタを呼び出し、初期化された新しいクラスのインスタンスをobject型として返します。

Copy
1<?php
2
3/**
4 * このクラスは意図的にコンストラクタを定義していません。
5 * ReflectionClass::newInstance を使ってインスタンス化する際に、
6 * コンストラクタが呼び出されない例として利用します。
7 */
8class SimpleClassWithoutConstructor
9{
10    public string $message = 'Hello from SimpleClassWithoutConstructor!';
11    public int $value = 123;
12
13    // コンストラクタ (__construct) が存在しないため、
14    // インスタンス生成時の初期化処理は行われません。
15}
16
17/**
18 * ReflectionClass::newInstance を使用して、コンストラクタを持たないクラスの
19 * インスタンスを生成する関数です。
20 *
21 * newInstance メソッドは通常、クラスにコンストラクタがあればそれを呼び出しますが、
22 * SimpleClassWithoutConstructor のようにコンストラクタが存在しない場合は、
23 * コンストラクタは呼び出されずに新しいインスタンスを返します。
24 * これは「newInstance を使用しつつコンストラクタを呼び出さない」という
25 * キーワードの意図に合致するシナリオです。
26 *
27 * @return SimpleClassWithoutConstructor 新しく生成されたクラスのインスタンス。
28 */
29function createInstanceWithNoConstructor(): SimpleClassWithoutConstructor
30{
31    // ReflectionClass オブジェクトを生成し、対象クラスの情報を取得します。
32    $reflector = new ReflectionClass(SimpleClassWithoutConstructor::class);
33
34    // newInstance メソッドを呼び出してインスタンスを生成します。
35    // SimpleClassWithoutConstructor にコンストラクタがないため、
36    // 引数を渡す必要もなく、コンストラクタも実行されません。
37    /** @var SimpleClassWithoutConstructor $instance */
38    $instance = $reflector->newInstance();
39
40    return $instance;
41}
42
43// --- サンプルコードの実行 ---
44echo "ReflectionClass::newInstance を使ってインスタンスを生成する例:\n\n";
45
46// 関数を呼び出してインスタンスを取得
47$myInstance = createInstanceWithNoConstructor();
48
49echo "生成されたインスタンスのプロパティを確認します:\n";
50echo "Message: " . $myInstance->message . "\n";
51echo "Value: " . $myInstance->value . "\n";
52
53// 上記の出力から、コンストラクタが実行されていないこと（または存在しないこと）が分かります。
54// もしコンストラクタが存在し、内部で何か出力していれば、それも表示されるはずですが、
55// この例では何も出力されません。

ReflectionClass::newInstanceメソッドは、PHPのリフレクションAPIの一部で、実行時に動的にクラスの新しいインスタンスを生成する際に使用されます。通常、クラスのインスタンス化はnew ClassName()で行いますが、このメソッドを利用すると、クラス名を文字列として指定し、柔軟にインスタンスを作成できます。

引数mixed ...$argsは、インスタンス化するクラスにコンストラクタ（__constructメソッド）が定義されている場合に、そのコンストラクタに渡す引数を指定するために使います。複数の引数を渡すことが可能です。しかし、対象のクラスにコンストラクタが存在しない場合は、これらの引数は不要となり、コンストラクタ自体も実行されません。

戻り値は、新しく生成されたクラスのオブジェクトです。

提供されたサンプルコードでは、コンストラクタを持たないSimpleClassWithoutConstructorクラスのインスタンスを生成する例が示されています。createInstanceWithNoConstructor関数内でReflectionClassオブジェクトを作成し、newInstanceメソッドを呼び出しています。このクラスにはコンストラクタがないため、newInstanceメソッドに引数を渡す必要はなく、コンストラクタの実行なしにインスタンスが生成されます。これにより、コンストラクタの有無に関わらずインスタンスを生成し、そのプロパティにアクセスできることを具体的に確認できます。