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

Copy
1<?php
2
3/**
4 * ClosureTestClass は、クロージャを生成し、そのコンテキストをデモンストレーションするためのクラスです。
5 */
6class ClosureTestClass
7{
8    /**
9     * クロージャ内部で static::class と get_called_class() の値を出力するクロージャを生成します。
10     *
11     * @return Closure
12     */
13    public static function createReportingClosure(): Closure
14    {
15        return function () {
16            // クロージャ内部で、現在のstaticスコープと呼び出し元クラス名を出力
17            echo "  クロージャ内部で static::class: " . static::class . PHP_EOL;
18            echo "  クロージャ内部で get_called_class(): " . get_called_class() . PHP_EOL;
19        };
20    }
21}
22
23/**
24 * AnotherClass は、クロージャをバインドする対象となる別のクラスです。
25 * これにより、クロージャの実行コンテキストが変化する様子を示します。
26 */
27class AnotherClass
28{
29    public function __construct() {}
30}
31
32// ----------------------------------------------------------------------
33echo "--- 1. クロージャが定義された元のスコープで実行される場合 ---" . PHP_EOL;
34
35// ClosureTestClass のスコープで定義されたクロージャを取得
36$originalClosure = ClosureTestClass::createReportingClosure();
37
38echo "元のクロージャを直接実行:" . PHP_EOL;
39$originalClosure();
40// クロージャ内部の static::class と get_called_class() は、定義元のクラスを示します。
41
42// このクロージャをリフレクションし、getClosureCalledClass() の結果を確認
43$refMethodOriginal = new ReflectionMethod($originalClosure, '__invoke');
44$calledClassOriginal = $refMethodOriginal->getClosureCalledClass();
45
46echo "ReflectionMethod::getClosureCalledClass() の結果: ";
47if ($calledClassOriginal !== null) {
48    echo $calledClassOriginal->getName() . PHP_EOL;
49} else {
50    // Closure::bindTo() で特定のクラスにバインドされていない場合、null を返します。
51    echo "null (クロージャが特定のクラスのコンテキストにバインドされていないため)" . PHP_EOL;
52}
53
54// ----------------------------------------------------------------------
55echo PHP_EOL . "--- 2. クロージャを別のクラスのコンテキストにバインドして実行される場合 ---" . PHP_EOL;
56
57// ClosureTestClass で定義されたクロージャを AnotherClass のコンテキストにバインド
58// bindTo の第2引数で、クロージャ内部の static スコープ（static::class や get_called_class() が参照するクラス）を指定します。
59$anotherInstance = new AnotherClass();
60$boundClosure = $originalClosure->bindTo($anotherInstance, AnotherClass::class);
61
62echo "AnotherClass にバインドされたクロージャを実行:" . PHP_EOL;
63$boundClosure();
64// クロージャ内部の static::class と get_called_class() は、バインドされた AnotherClass を示します。
65
66// バインドされたクロージャをリフレクションし、getClosureCalledClass() の結果を確認
67$refMethodBound = new ReflectionMethod($boundClosure, '__invoke');
68$calledClassBound = $refMethodBound->getClosureCalledClass();
69
70echo "ReflectionMethod::getClosureCalledClass() の結果: ";
71if ($calledClassBound !== null) {
72    // bindTo でバインドされた AnotherClass が ReflectionClass オブジェクトとして返されます。
73    echo $calledClassBound->getName() . PHP_EOL;
74} else {
75    echo "null (予期せぬ結果)" . PHP_EOL; // このケースでは通常 null は返りません。
76}

ReflectionMethod::getClosureCalledClassは、PHP 8で導入されたリフレクションAPIのメソッドで、クロージャが特定のクラスのコンテキストにバインドされている場合に、その呼び出し元クラスの情報を取得します。

このメソッドは引数を必要としません。戻り値として、クロージャがClosure::bindToメソッドなどによって特定のクラスにバインドされている場合、そのクラスを表すReflectionClassオブジェクトを返します。もしクロージャがどのクラスのコンテキストにもバインドされていない場合は、nullを返します。

サンプルコードでは、まずClosureTestClass内で生成されたクロージャを直接実行します。このクロージャは特定のクラスにバインドされていないため、ReflectionMethod::getClosureCalledClass()はnullを返します。クロージャ内部のstatic::classやget_called_class()も定義元のClosureTestClassを示します。

次に、同じクロージャをAnotherClassのインスタンスにバインドし直して実行します。Closure::bindToによりクロージャの実行コンテキストがAnotherClassに変更されるため、ReflectionMethod::getClosureCalledClass()はAnotherClassのReflectionClassオブジェクトを返します。このとき、クロージャ内部のstatic::classやget_called_class()もAnotherClassを示すようになります。

このようにgetClosureCalledClass()を使用することで、クロージャがどのクラスのコンテキストで実行されるようにバインドされているかをリフレクションを通じて動的に確認できるため、クロージャの振る舞いや実行コンテキストを解析する際に役立ちます。

Copy
1<?php
2
3/**
4 * ReflectionMethod::getClosureCalledClass の使用例を示します。
5 * このメソッドは、クロージャがバインドされているクラス（または静的スコープクラス）を返します。
6 * これは、クロージャ内で `static::` キーワードが解決されるクラスを指します。
7 */
8
9// 1. クラスにバインドされていない通常のクロージャ
10$unboundClosure = function () {
11    // クロージャ内部で $this が利用可能か確認し、そのクラス名を表示します。
12    echo "  クロージャ内: \$this は " . (isset($this) ? get_class($this) : "未設定") . " です。\n";
13};
14
15echo "--- 1. クラスにバインドされていないクロージャ ---\n";
16$unboundClosure(); // グローバルスコープでクロージャを実行
17
18// ReflectionMethod を使ってクロージャをリフレクションします。
19// クロージャは実質的に __invoke メソッドを持つオブジェクトとして扱われます。
20$reflectionUnbound = new ReflectionMethod($unboundClosure, '__invoke');
21
22// getClosureCalledClass を呼び出して、クロージャの呼び出し元（バインド先）クラスを取得します。
23$calledClassUnbound = $reflectionUnbound->getClosureCalledClass();
24
25echo "  getClosureCalledClass の結果: ";
26if ($calledClassUnbound) {
27    echo $calledClassUnbound->getName() . "\n";
28} else {
29    echo "null (クラスのコンテキストにバインドされていません)\n";
30}
31
32// 2. クラスに明示的にバインドされたクロージャ
33class MyService {
34    public string $instanceName = "MyServiceインスタンス";
35}
36
37// `bindTo` メソッドを使用して、クロージャを MyService クラスのコンテキストにバインドします。
38//   - 第1引数: クロージャ内の $this となるオブジェクト。
39//   - 第2引数: クロージャの静的スコープとなるクラス名（またはオブジェクト）。これが getClosureCalledClass の結果に影響します。
40$serviceInstance = new MyService();
41$boundClosure = $unboundClosure->bindTo($serviceInstance, MyService::class);
42
43echo "\n--- 2. MyService クラスに明示的にバインドされたクロージャ ---\n";
44$boundClosure(); // MyService インスタンスのコンテキストでクロージャを実行
45
46$reflectionBound = new ReflectionMethod($boundClosure, '__invoke');
47$calledClassBound = $reflectionBound->getClosureCalledClass();
48
49echo "  getClosureCalledClass の結果: ";
50if ($calledClassBound) {
51    echo $calledClassBound->getName() . "\n"; // MyService が表示されます
52} else {
53    echo "null (バインドされているため、通常このパスは実行されません)\n";
54}
55
56// 3. static キーワードで定義されたクロージャ
57// static クロージャは $this をバインドせず、常にグローバルスコープで `static::` が解決されます。
58$staticClosure = static function () {
59    echo "  static クロージャ内: \$this は設定されません。\n";
60};
61
62echo "\n--- 3. static クロージャ ---\n";
63$staticClosure();
64
65$reflectionStatic = new ReflectionMethod($staticClosure, '__invoke');
66$calledClassStatic = $reflectionStatic->getClosureCalledClass();
67
68echo "  getClosureCalledClass の結果: ";
69if ($calledClassStatic) {
70    echo $calledClassStatic->getName() . "\n";
71} else {
72    echo "null (static クロージャはクラスのコンテキストにバインドされません)\n";
73}
74
75?>

ReflectionMethod::getClosureCalledClassは、PHPのクロージャ（無名関数）が「どのクラスのコンテキストにバインドされているか」、または「クロージャ内でstatic::キーワードが解決されるクラスは何か」を示す情報を取得するメソッドです。このメソッドは引数を取らず、クロージャのバインド先クラスを表すReflectionClassオブジェクトを返すか、クラスのコンテキストにバインドされていない場合はnullを返します。

サンプルコードでは、このメソッドの挙動を3つの異なる状況で示しています。

まず、クラスにバインドされていない通常のクロージャの場合、getClosureCalledClassはnullを返します。これは、クロージャが特定のクラスのコンテキストを持たないためです。

次に、Closure::bindToメソッドを使って**MyServiceクラスのコンテキストに明示的にバインドされたクロージャ**の場合です。このクロージャはMyServiceのコンテキストで実行されるため、getClosureCalledClassはMyServiceクラスのReflectionClassオブジェクトを返します。これにより、クロージャがどのクラスの内部で動作するべきかがプログラム的に確認できます。

最後に、staticキーワードで定義されたクロージャの場合、このクロージャは$thisをバインドせず、常にグローバルスコープでstatic::が解決されます。そのため、getClosureCalledClassはnullを返します。

このメソッドは、クロージャの実行コンテキストや、static::キーワードの解決元となるクラスを動的に把握したい場合に役立ちます。