【PHP8.x】forward_static_call_array()関数の使い方

Copy
1<?php
2
3/**
4 * 基底クラス。
5 * forward_static_call_array の動作を示すために使用します。
6 */
7class BaseClass
8{
9    /**
10     * 静的メソッド。
11     * 呼び出し元のクラス名とメッセージを表示します。
12     * static::class を使用することで、最終的に呼び出されたクラスの名前がわかります。
13     *
14     * @param string $message 表示するメッセージ
15     */
16    public static function demonstrateStaticCall(string $message): void
17    {
18        echo "Called from " . static::class . " with message: \"$message\"\n";
19    }
20
21    /**
22     * forward_static_call_array を使用して静的メソッドを呼び出すメソッド。
23     * このメソッド自身がインスタンスメソッドであっても、
24     * forward_static_call_array は、このメソッドを呼び出したオブジェクトの
25     * 「静的スコープ (static::)」を維持します。
26     *
27     * @param string $inputMessage 静的メソッドに渡すメッセージ
28     */
29    public function callStaticMethodUsingForward(string $inputMessage): void
30    {
31        echo "--- Calling static method from " . static::class . " instance ---\n";
32        // 'static::demonstrateStaticCall' は、このメソッドを呼び出したオブジェクトのクラスの
33        // コンテキスト（遅延静的束縛）で解決されます。
34        // 例えば、DerivedClass のインスタンスから呼ばれた場合、DerivedClass::demonstrateStaticCall が呼び出されます。
35        // 引数は配列形式で渡します。
36        forward_static_call_array(['static', 'demonstrateStaticCall'], [$inputMessage]);
37        echo "--------------------------------------------------\n";
38    }
39}
40
41/**
42 * BaseClass を継承する派生クラス。
43 * BaseClass の demonstrateStaticCall メソッドをオーバーライドして、
44 * forward_static_call_array がどのように動作するかを示します。
45 */
46class DerivedClass extends BaseClass
47{
48    /**
49     * 派生クラスに特有の静的メソッド。
50     * BaseClass の demonstrateStaticCall と同じ名前ですが、
51     * DerivedClass のコンテキストで static:: が解決された場合にこちらが呼ばれます。
52     *
53     * @param string $message 表示するメッセージ
54     */
55    public static function demonstrateStaticCall(string $message): void
56    {
57        echo "Called from " . static::class . " (DerivedClass specific) with message: \"$message\"\n";
58    }
59}
60
61// --- サンプルコードの実行例 ---
62
63// BaseClass のインスタンスを作成し、メソッドを呼び出す
64$baseInstance = new BaseClass();
65$baseInstance->callStaticMethodUsingForward("Hello from BaseClass instance!");
66// 期待される出力: Called from BaseClass with message: "Hello from BaseClass instance!"
67
68echo "\n"; // 出力を見やすくするための改行
69
70// DerivedClass のインスタンスを作成し、BaseClass で定義されたメソッドを呼び出す
71// ここで forward_static_call_array の効果が顕著になります。
72// BaseClass::callStaticMethodUsingForward が呼ばれますが、
73// その中で forward_static_call_array(['static', 'demonstrateStaticCall'], ...) を実行すると、
74// 'static::' は $derivedInstance のクラスである DerivedClass を指します。
75$derivedInstance = new DerivedClass();
76$derivedInstance->callStaticMethodUsingForward("Hello from DerivedClass instance!");
77// 期待される出力: Called from DerivedClass (DerivedClass specific) with message: "Hello from DerivedClass instance!"

forward_static_call_arrayは、PHPにおいて、クラスの継承関係で静的メソッドを呼び出す際に、呼び出し元のクラスの静的スコープを維持したまま実行するための関数です。第一引数$callbackには、呼び出したい静的メソッドを['クラス名', 'メソッド名']または['static', 'メソッド名']のような形式で指定します。特に['static', 'メソッド名']を使用すると、遅延静的束縛が適用され、実際にインスタンスを作成したクラスのコンテキストでメソッドが解決されます。第二引数$argsには、呼び出すメソッドに渡す引数を配列として設定します。戻り値はmixedで、呼び出されたメソッドが返した結果となります。

この関数の大きな特徴は、親クラスのメソッド内でforward_static_call_arrayを使ってstatic::メソッド名を呼び出すと、そのメソッドがたとえ子クラスのインスタンスから呼ばれたとしても、static::は実際にインスタンスを作成した子クラスを指す点です。これにより、子クラスでオーバーライドされた静的メソッドがあれば、親クラスのメソッド内からでも子クラスの実装が呼び出され、static::classも子クラスの名前を示します。サンプルコードのDerivedClassの例では、BaseClassのcallStaticMethodUsingForwardメソッドがDerivedClassのインスタンスから呼ばれると、forward_static_call_arrayによってDerivedClass::demonstrateStaticCallが実行されるのがその具体例です。この機能は、クラス階層における柔軟なポリモーフィズムを実現する際に非常に有用です。

Copy
1<?php
2
3/**
4 * 親クラスは静的メソッドを定義します。
5 */
6class ParentClass
7{
8    /**
9     * この静的メソッドは、呼び出された際のコンテキスト（static::class）と
10     * 受け取ったメッセージを出力します。
11     *
12     * @param string $message 呼び出し元から渡されるメッセージ
13     * @return string 実行結果の文字列
14     */
15    public static function demonstrateContext(string $message): string
16    {
17        // static::class は、遅延静的バインディングのルールに従い、
18        // 実際に呼び出しを行ったクラスの名前を返します。
19        // これが ParentClass ではなく ChildClass になることが、
20        // forward_static_call_array の重要なポイントです。
21        return "ParentClass::demonstrateContext() called by " . static::class . " with message: \"{$message}\"";
22    }
23}
24
25/**
26 * 子クラスは親クラスを継承し、forward_static_call_array を使用して
27 * 親クラスの静的メソッドを呼び出します。
28 */
29class ChildClass extends ParentClass
30{
31    /**
32     * forward_static_call_array を使って親クラスの静的メソッドを呼び出すラッパーメソッドです。
33     *
34     * @param string $inputMessage 親メソッドに渡すメッセージ
35     * @return mixed 親メソッドからの戻り値
36     */
37    public function invokeParentStaticMethod(string $inputMessage): mixed
38    {
39        // 呼び出すコールバックを定義します。
40        // 親クラスの demonstrateContext 静的メソッドを指します。
41        $callback = [parent::class, 'demonstrateContext'];
42
43        // 親メソッドに渡す引数を配列で定義します。
44        $args = [$inputMessage];
45
46        // forward_static_call_array を使用して、親クラスの静的メソッドを呼び出します。
47        // この呼び出しにより、demonstrateContext メソッド内の static::class は、
48        // この ChildClass のコンテキスト（'ChildClass'）で評価されます。
49        return forward_static_call_array($callback, $args);
50    }
51}
52
53// サンプルコードの実行部分
54// ChildClass のインスタンスを作成します。
55$child = new ChildClass();
56
57// ChildClass のメソッドを呼び出し、forward_static_call_array を介して
58// 親の静的メソッドを実行させます。
59$result = $child->invokeParentStaticMethod("Hello from ChildClass!");
60
61// 結果を出力します。
62// static::class が 'ChildClass' となることを確認してください。
63echo $result . PHP_EOL;
64
65?>

PHPのforward_static_call_array関数は、指定した静的メソッドを、現在実行中のクラスのコンテキストで呼び出すための機能です。通常、親クラスの静的メソッドを呼び出すと、そのメソッド内のstatic::classは親クラス名を示します。しかし、この関数を使用すると、親クラスの静的メソッドを呼び出しつつも、static::classが呼び出し元のクラス（子クラスなど）を指すようになります。

サンプルコードでは、ParentClassが静的メソッドdemonstrateContextを定義しており、このメソッドは呼び出されたクラスの名前（static::class）を出力します。ChildClassはParentClassを継承し、自身のメソッド内でforward_static_call_arrayを使用しています。

第一引数$callbackには、[親クラス名, メソッド名]のように呼び出したいメソッドを指定します。第二引数$argsには、そのメソッドに渡す引数を配列として指定します。

これにより、ChildClassからParentClass::demonstrateContextを呼び出す際、demonstrateContextメソッド内のstatic::classがParentClassではなくChildClassとして評価されます。戻り値は呼び出されたメソッドの返り値となります。この挙動は、静的メソッドの実行コンテキストを制御したい場合に非常に役立ちます。