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

Copy
1<?php
2
3// 処理対象となるクラスを定義します。
4class User
5{
6    public function __construct(public string $name) {}
7}
8
9// 別の処理対象となるクラスを定義します。
10class Product
11{
12    public function __construct(public string $name) {}
13}
14
15// メソッドの引数をリフレクションで検査するクラスを定義します。
16class OrderService
17{
18    /**
19     * 注文を処理するメソッド。
20     * 複数の引数があり、それぞれ異なる型ヒントを持ちます。
21     *
22     * @param User $user ユーザー情報オブジェクト
23     * @param Product $product 商品情報オブジェクト
24     * @param int $quantity 数量
25     * @param bool $isGift 贈り物かどうか (型ヒントなし)
26     */
27    public function processOrder(User $user, Product $product, int $quantity, $isGift = false): void
28    {
29        // このメソッドは実行されませんが、引数の型情報を検査するために使用します。
30        echo "Processing order for {$user->name}, product {$product->name}, quantity {$quantity}.\n";
31    }
32}
33
34echo "--- ReflectionParameter::getClass() の使用例 ---\n\n";
35
36// OrderService クラスの processOrder メソッドのリフレクションオブジェクトを作成します。
37$reflectionMethod = new ReflectionMethod(OrderService::class, 'processOrder');
38
39// メソッドの各引数について情報を取得します。
40foreach ($reflectionMethod->getParameters() as $parameter) {
41    echo "引数名: " . $parameter->getName() . "\n";
42
43    // ReflectionParameter::getClass() を呼び出し、引数の型ヒントがクラスである場合に ReflectionClass オブジェクトを取得します。
44    // クラス型ヒントがない場合は null が返されます。
45    $reflectionClass = $parameter->getClass();
46
47    if ($reflectionClass !== null) {
48        // クラス型ヒントが存在する場合、そのクラス名を表示します。
49        echo "  クラス型ヒント: " . $reflectionClass->getName() . "\n";
50    } else {
51        // クラス型ヒントがない場合、その他の型ヒントや状態を表示します。
52        $type = $parameter->getType();
53        if ($type instanceof ReflectionNamedType) {
54            echo "  スカラー型ヒントまたは組み込み型: " . $type->getName() . "\n";
55        } else {
56            echo "  クラスまたはスカラー型ヒントなし。\n";
57        }
58    }
59    echo "--------------------\n";
60}
61
62?>

PHP 8のReflectionParameter::getClass()メソッドは、メソッドや関数の引数に関する詳細な情報を取得するReflectionParameterクラスの一部です。このメソッドは引数を持たず、対象の引数がクラスの型ヒントを持っている場合に、そのクラスを詳細に調査できるReflectionClassオブジェクトを返します。もし引数にクラスの型ヒントが指定されていない場合は、nullを返します。

サンプルコードでは、OrderServiceクラスのprocessOrderメソッドを例に、各引数の型ヒントを検査しています。processOrderメソッドの引数には、UserやProductのようなクラスの型ヒント、intのようなスカラー型ヒント、そして型ヒントがない引数が含まれています。

ReflectionParameter::getClass()を呼び出すと、$user引数からはUserクラスのReflectionClassオブジェクトが、$product引数からはProductクラスのReflectionClassオブジェクトが取得できます。これにより、その引数がどのようなクラスを期待しているかをプログラムで動的に知ることができます。一方、$quantity（int型）や$isGift（型ヒントなし）のような引数に対してはnullが返されるため、クラス以外の型ヒントであることや、型ヒントがないことを判別できます。このように、プログラムの実行中にコードの構造を深く分析する「リフレクション」機能の一つとして利用されます。

Copy
1<?php
2
3/**
4 * リフレクションで使用するサンプルクラスです。
5 */
6class UserService
7{
8    // 何らかのサービスロジック
9}
10
11/**
12 * 別のリフレクションで使用するサンプルクラスです。
13 */
14class UserRepository
15{
16    // 何らかのリポジトリロジック
17}
18
19/**
20 * 引数にクラス型ヒント、スカラー型ヒント、および型ヒントなしを持つサンプル関数です。
21 * ReflectionParameter::getClass() の動作を示すために使用します。
22 *
23 * @param UserService $service サービスオブジェクト（クラス型ヒント）
24 * @param int $id ユーザーID（スカラー型ヒント）
25 * @param string $name ユーザー名（スカラー型ヒント）
26 * @param UserRepository $repository リポジトリオブジェクト（別のクラス型ヒント）
27 * @param $options オプション（型ヒントなし）
28 */
29function processUserData(
30    UserService $service,
31    int $id,
32    string $name,
33    UserRepository $repository,
34    $options
35) {
36    // この関数の具体的なロジックは重要ではありません。
37    // 引数の型をリフレクションで調べるのが目的です。
38}
39
40// processUserData 関数をリフレクションします。
41$function = new ReflectionFunction('processUserData');
42
43echo "--- 関数 'processUserData' の引数情報 ---" . PHP_EOL . PHP_EOL;
44
45// 関数の各引数をループ処理します。
46foreach ($function->getParameters() as $parameter) {
47    echo "引数名: {$parameter->getName()}" . PHP_EOL;
48
49    // ReflectionParameter::getClass() を呼び出し、引数の型ヒントがクラスであるかを確認します。
50    // 引数がクラス型ヒントを持つ場合、ReflectionClass オブジェクトが返されます。
51    // それ以外の場合（スカラー型、組み込み型、型ヒントなし）、null が返されます。
52    $reflectionClass = $parameter->getClass();
53
54    if ($reflectionClass !== null) {
55        // ReflectionClass オブジェクトが返された場合、そのクラス名を取得して表示します。
56        // ここでキーワード "getclassname" に関連する情報が得られます。
57        echo "  型ヒント: クラス -> " . $reflectionClass->getName() . PHP_EOL;
58    } else {
59        // null が返された場合、引数がクラス型ヒントを持たないことを示します。
60        // その他の型情報を取得するには getType() を使用できます。
61        $type = $parameter->getType();
62        if ($type instanceof ReflectionNamedType) {
63            echo "  型ヒント: " . $type->getName() . " (スカラー型または組み込み型)" . PHP_EOL;
64        } else {
65            echo "  型ヒント: なし" . PHP_EOL;
66        }
67    }
68    echo PHP_EOL;
69}

PHP 8のReflectionParameter::getClass()メソッドは、関数の引数が持つ型ヒントがクラスであるかどうかを調べ、そのクラスに関する詳細情報を取得するための機能です。このメソッドは引数を持たず、対象の引数がクラスの型ヒントを持つ場合にReflectionClassオブジェクトを返します。それ以外の場合（スカラー型、組み込み型、または型ヒントなし）はnullを返します。

サンプルコードでは、様々な型ヒントを持つprocessUserData関数の引数をリフレクションで分析しています。ReflectionFunctionから取得した各引数（ReflectionParameter）に対し、getClass()メソッドを呼び出しています。

UserService $serviceのようにクラス型ヒントが指定された引数に対しては、ReflectionClassオブジェクトが戻り値として得られます。このオブジェクトのgetName()メソッドを呼び出すことで、「UserService」といったクラス名（getclassname）を動的に取得・表示できます。一方、int $idのようなスカラー型や型ヒントがない引数ではnullが返されるため、これらの型情報はgetType()メソッドで別途確認する流れです。

このメソッドを使うことで、プログラムの実行時に動的に引数のクラス型を特定し、その情報を利用した処理を行うことが可能になります。