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

Copy
1<?php
2
3/**
4 * サンプルクラス
5 * 静的メソッドとインスタンスメソッドの両方を含む
6 */
7class MySampleClass
8{
9    /**
10     * 静的メソッド
11     * クラスのインスタンス化なしに呼び出せる
12     */
13    public static function staticMethod(): string
14    {
15        return "これは静的メソッドです。";
16    }
17
18    /**
19     * インスタンスメソッド
20     * クラスをインスタンス化しないと呼び出せない
21     */
22    public function instanceMethod(): string
23    {
24        return "これはインスタンスメソッドです。";
25    }
26}
27
28// 静的メソッドのリフレクションを取得し、isStatic()を呼び出す
29try {
30    $staticMethodRef = new ReflectionMethod('MySampleClass', 'staticMethod');
31    echo "メソッド 'staticMethod' は静的メソッドですか？ " . ($staticMethodRef->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
32} catch (ReflectionException $e) {
33    echo "エラー: " . $e->getMessage() . PHP_EOL;
34}
35
36
37// インスタンスメソッドのリフレクションを取得し、isStatic()を呼び出す
38try {
39    $instanceMethodRef = new ReflectionMethod('MySampleClass', 'instanceMethod');
40    echo "メソッド 'instanceMethod' は静的メソッドですか？ " . ($instanceMethodRef->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
41} catch (ReflectionException $e) {
42    echo "エラー: " . $e->getMessage() . PHP_EOL;
43}
44
45?>

PHPのReflectionMethod::isStaticメソッドは、クラスの特定のメソッドが「静的メソッド」であるかどうかをプログラム実行時に判断するために使用されます。静的メソッドとは、クラスをインスタンス化（オブジェクトを作成）することなく、クラス名を使って直接呼び出すことができるメソッドのことです。メソッドの定義にstaticキーワードを付けることで宣言されます。

このメソッドは引数を一切取りません。呼び出すと、対象のメソッドが静的メソッドであればtrue（真）を、そうでない場合はfalse（偽）を真偽値（bool型）として返します。

サンプルコードでは、まずMySampleClassというクラスを定義し、静的メソッドstaticMethodとインスタンスメソッドinstanceMethodを含めています。 次に、ReflectionMethodクラスを使用して、それぞれのメソッドに対するリフレクションオブジェクトを作成しています。 作成したリフレクションオブジェクトからisStatic()メソッドを呼び出すことで、そのメソッドが静的であるかを確認しています。staticMethodに対してはtrueが返されるため「はい」と表示され、instanceMethodに対してはfalseが返されるため「いいえ」と表示されます。これにより、任意のメソッドが静的な振る舞いをするかどうかを簡単に判別することができます。

Copy
1<?php
2
3/**
4 * ReflectionMethod::isStatic の使用例
5 *
6 * このスクリプトは、クラス内のメソッドが静的であるか（staticキーワードで定義されているか）を
7 * ReflectionAPI を使用して判定する方法を示します。
8 * また、静的メソッド、インスタンスメソッド、静的プロパティ（静的変数）の基本的な概念と
9 * その呼び出し方も含み、システムエンジニアを目指す初心者にも分かりやすいように設計されています。
10 */
11class MyClass
12{
13    /**
14     * @var string 静的プロパティ（静的変数）。
15     * クラスのインスタンスを作成せずに、クラス名::$プロパティ名 でアクセスできます。
16     */
17    public static string $staticProperty = "これはMyClassの静的プロパティです。";
18
19    /**
20     * 静的メソッド。
21     * クラスのインスタンスを作成せずに、MyClass::staticMethod() のように直接呼び出せます。
22     */
23    public static function staticMethod(): string
24    {
25        // 静的メソッド内で静的プロパティにアクセスするには self::$propertyName を使用します。
26        return "静的メソッドが実行されました。内部で静的プロパティにアクセス: " . self::$staticProperty;
27    }
28
29    /**
30     * インスタンスメソッド。
31     * クラスのインスタンスを作成してから、$instance->instanceMethod() のように呼び出す必要があります。
32     */
33    public function instanceMethod(): string
34    {
35        return "インスタンスメソッドが実行されました。このメソッドはインスタンスが必要です。";
36    }
37}
38
39// クラスのReflection情報を作成します
40$reflectionClass = new ReflectionClass(MyClass::class);
41
42echo "--- ReflectionMethod::isStatic の使用例 ---\n\n";
43
44// 'staticMethod' のReflectionMethodインスタンスを取得します
45$staticMethodRef = $reflectionClass->getMethod('staticMethod');
46
47// isStatic() メソッドを使用して、staticMethod が静的メソッドかどうかを判定します
48if ($staticMethodRef->isStatic()) {
49    echo "メソッド '" . $staticMethodRef->getName() . "' は静的メソッドです。\n";
50} else {
51    echo "メソッド '" . $staticMethodRef->getName() . "' は静的メソッドではありません。\n";
52}
53
54// 'instanceMethod' のReflectionMethodインスタンスを取得します
55$instanceMethodRef = $reflectionClass->getMethod('instanceMethod');
56
57// isStatic() メソッドを使用して、instanceMethod が静的メソッドかどうかを判定します
58if ($instanceMethodRef->isStatic()) {
59    echo "メソッド '" . $instanceMethodRef->getName() . "' は静的メソッドです。\n";
60} else {
61    echo "メソッド '" . $instanceMethodRef->getName() . "' は静的メソッドではありません。\n";
62}
63
64echo "\n--- 静的メンバーとインスタンスメンバーの呼び出し例 ---\n\n";
65
66// 静的メソッドはクラス名::メソッド名 で直接呼び出します
67echo "静的メソッドの呼び出し: " . MyClass::staticMethod() . "\n";
68
69// 静的プロパティ（静的変数）はクラス名::$プロパティ名 で直接アクセスします
70echo "静的プロパティへのアクセス: " . MyClass::$staticProperty . "\n";
71
72// インスタンスメソッドを呼び出すには、まずクラスのインスタンスを作成します
73$myObject = new MyClass();
74echo "インスタンスメソッドの呼び出し: " . $myObject->instanceMethod() . "\n";
75
76?>

PHPのReflectionMethod::isStaticメソッドは、指定されたクラスのメソッドが「静的メソッド」として定義されているか（staticキーワードが付いているか）をプログラムで判定するために使用されます。これは、クラスやメソッドの構造を動的に調べることができるPHPのリフレクションAPIの一部です。

このメソッドは引数を持ちません。メソッドが静的であればtrueを、静的でなければfalseを真偽値（bool）として返します。

サンプルコードでは、まずMyClassというクラスが定義されています。このクラスには、staticキーワードで定義された「静的メソッド」であるstaticMethodと、staticキーワードがない「インスタンスメソッド」であるinstanceMethodがあります。また、staticキーワードを持つ「静的プロパティ（静的変数）」も定義されています。

ReflectionMethod::isStaticは、これらのメソッドのReflectionMethodインスタンスを取得し、それぞれが静的メソッドであるかを判定しています。静的メソッドや静的プロパティはクラスのインスタンスを作成せずに直接呼び出せますが、インスタンスメソッドはクラスのインスタンスを作成してから呼び出す必要があります。このisStaticメソッドを使うことで、このようなメソッドの性質をコードから確認できるのです。