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

Copy
1<?php
2
3/**
4 * フォームからのアクションを処理するサンプルクラス。
5 * フォームのname属性の値が、このクラスのメソッド名に対応することを想定しています。
6 */
7class FormActionProcessor
8{
9    /**
10     * ユーザー名処理メソッド。
11     * フォームのname="action"が"processUsername"の場合に呼び出されます。
12     *
13     * @param string $username フォームのname="username"の値。
14     * @return string 処理結果メッセージ。
15     */
16    public function processUsername(string $username): string
17    {
18        return "ユーザー名 '{$username}' を処理しました。";
19    }
20
21    /**
22     * メールアドレス処理メソッド。
23     * フォームのname="action"が"processEmail"の場合に呼び出されます。
24     *
25     * @param string $email フォームのname="email"の値。
26     * @return string 処理結果メッセージ。
27     */
28    public function processEmail(string $email): string
29    {
30        return "メールアドレス '{$email}' を処理しました。";
31    }
32}
33
34// ここからがメインの処理ロジックです。
35
36// フォームから送信されたデータをシミュレートします。
37// 実際には $_POST や $_GET スーパーグローバル変数からデータが来ます。
38// キーがフォームのname属性に相当します。
39$_POST = [
40    'action' => 'processUsername', // フォームのname="action"で呼び出すメソッド名を指定
41    'username' => 'php_user_001',   // フォームのname="username"でメソッドの引数を指定
42    'email' => 'user@example.com',  // フォームのname="email"でメソッドの引数を指定
43];
44
45$processor = new FormActionProcessor();
46$outputMessage = "アクションが指定されていません。";
47
48// フォームのname="action"から、実行したいメソッド名を取得します。
49$actionMethodName = $_POST['action'] ?? '';
50
51if (!empty($actionMethodName)) {
52    try {
53        // ReflectionMethod::createFromMethodName を使用して、
54        // クラス名とメソッド名の文字列から ReflectionMethod オブジェクトを生成します。
55        // 引数 $method は "ClassName::methodName" の形式で指定します。
56        $reflectionMethod = ReflectionMethod::createFromMethodName(
57            FormActionProcessor::class . '::' . $actionMethodName
58        );
59
60        // セキュリティのため、メソッドが FormActionProcessor クラスの公開メソッドであることを確認します。
61        if ($reflectionMethod->isPublic() && $reflectionMethod->getDeclaringClass()->getName() === FormActionProcessor::class) {
62            $args = [];
63            // メソッドの引数情報を取得し、フォームデータから適切な値をマッピングします。
64            foreach ($reflectionMethod->getParameters() as $parameter) {
65                $paramName = $parameter->getName();
66                // フォームのname属性とメソッドの引数名が一致すると仮定して値をセットします。
67                // 引数がオプショナルで値が提供されない場合は、デフォルト値を使用します。
68                $args[] = $_POST[$paramName] ?? ($parameter->isOptional() ? $parameter->getDefaultValue() : null);
69            }
70
71            // ReflectionMethod オブジェクトを使ってメソッドを動的に呼び出します。
72            // invokeArgs() は、配列で引数を渡すことができます。
73            $outputMessage = $reflectionMethod->invokeArgs($processor, $args);
74        } else {
75            $outputMessage = "エラー: 指定されたアクション '{$actionMethodName}' は無効か、アクセスできません。";
76        }
77    } catch (ReflectionException $e) {
78        // 指定されたメソッドが存在しない場合のエラーを捕捉します。
79        $outputMessage = "エラー: アクション '{$actionMethodName}' は存在しません。 " . $e->getMessage();
80    }
81}
82
83// 処理結果を出力します。
84echo $outputMessage;
85

このサンプルコードは、Webフォームから送信された情報（特にフォーム要素のname属性の値）に基づいて、PHPのクラスメソッドを動的に呼び出す方法を示しています。

まず、FormActionProcessorクラスは、ユーザー名やメールアドレスの処理を行うメソッド群を定義しています。Webフォームで例えばname="action"という要素にprocessUsernameという値が設定されていた場合、このコードはその値に対応するメソッドを呼び出します。

ここでの中心となるのが、ReflectionMethod::createFromMethodNameというメソッドです。これは、クラス名とメソッド名を結合した文字列（例えば"FormActionProcessor::processUsername"）を引数$methodとして受け取ります。この引数に基づいて、指定されたメソッドに関する詳細な情報を持つReflectionMethodオブジェクトを生成し、戻り値として返します。

生成されたReflectionMethodオブジェクトは、メソッドが公開されているか、どのような引数を受け取るかといった情報を取得するために利用されます。サンプルコードでは、セキュリティのためにメソッドが公開されているかを確認した後、フォームから渡されたデータ（$_POST）をメソッドの引数に適切にマッピングし、最終的にinvokeArgs()メソッドを使って対象のメソッドを動的に実行しています。これにより、フォームのname属性で指定された値に応じて、柔軟に処理を切り替えるシステムを構築できます。

Copy
1<?php
2
3// リフレクションの対象となるサンプルクラスを定義します。
4class UserProcessor
5{
6    /**
7     * ユーザーのフルネームを結合して返します。
8     *
9     * @param string $firstName
10     * @param string $lastName
11     * @return string
12     */
13    public function getFullName(string $firstName, string $lastName): string
14    {
15        return $firstName . ' ' . $lastName;
16    }
17
18    /**
19     * ユーザーの年齢を確認するプライベートメソッド。
20     * リフレクションでアクセスできることを示します。
21     *
22     * @param int $age
23     * @return bool
24     */
25    private function isValidAge(int $age): bool
26    {
27        return $age >= 18;
28    }
29}
30
31/**
32 * ReflectionMethod::createFromMethodName の使用例
33 *
34 * このファクトリメソッドは、'クラス名::メソッド名' の形式の文字列を受け取り、
35 * そのメソッドに対応する ReflectionMethod オブジェクトを直接生成します。
36 * システムエンジニア初心者の方へ: PHPの実行時にクラスやメソッドの構造を
37 * 調べる「リフレクション」という機能で、このメソッドはそのオブジェクトを
38 * 作成する便利な方法の一つです。
39 */
40try {
41    // 'UserProcessor::getFullName' という文字列から ReflectionMethod オブジェクトを作成します。
42    $reflectionMethod = ReflectionMethod::createFromMethodName('UserProcessor::getFullName');
43
44    echo "--- メソッド 'getFullName' の情報 ---" . PHP_EOL;
45    echo "メソッド名: " . $reflectionMethod->getName() . PHP_EOL;
46    echo "所属クラス: " . $reflectionMethod->getDeclaringClass()->getName() . PHP_EOL;
47    echo "publicメソッドか: " . ($reflectionMethod->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
48    echo "パラメータ数: " . $reflectionMethod->getNumberOfParameters() . PHP_EOL;
49
50    // メソッドのパラメータ情報を表示します。
51    foreach ($reflectionMethod->getParameters() as $parameter) {
52        echo "  - パラメータ名: " . $parameter->getName() . PHP_EOL;
53        echo "    型ヒント: " . ($parameter->hasType() ? $parameter->getType()->getName() : 'なし') . PHP_EOL;
54    }
55
56    echo PHP_EOL;
57
58    // private メソッドも同様にリフレクションできます。
59    // アクセス修飾子に関わらず、メソッド名から ReflectionMethod オブジェクトを作成可能です。
60    $reflectionPrivateMethod = ReflectionMethod::createFromMethodName('UserProcessor::isValidAge');
61
62    echo "--- メソッド 'isValidAge' の情報 (private) ---" . PHP_EOL;
63    echo "メソッド名: " . $reflectionPrivateMethod->getName() . PHP_EOL;
64    echo "privateメソッドか: " . ($reflectionPrivateMethod->isPrivate() ? 'はい' : 'いいえ') . PHP_EOL;
65    echo "戻り値の型: " . ($reflectionPrivateMethod->hasReturnType() ? $reflectionPrivateMethod->getReturnType()->getName() : 'なし') . PHP_EOL;
66
67} catch (ReflectionException $e) {
68    // 指定されたクラスやメソッド名が存在しない場合に ReflectionException が発生します。
69    echo "エラー: 指定したクラスまたはメソッドが見つかりません。(" . $e->getMessage() . ")" . PHP_EOL;
70}

このPHPのサンプルコードは、ReflectionMethod::createFromMethodNameメソッドの使い方を示しています。これは、プログラムの実行中にクラスやメソッドの構造を調べる「リフレクション」という機能の一部です。createFromMethodNameは、'クラス名::メソッド名'という形式の文字列（例えば 'UserProcessor::getFullName'）を引数として受け取り、指定されたメソッドに関する情報を持つReflectionMethodオブジェクトを直接生成します。戻り値は、そのメソッドの詳細を調査できるReflectionMethodオブジェクトです。

サンプルコードでは、まずUserProcessorクラスとその中に定義されたgetFullName（public）およびisValidAge（private）メソッドを定義しています。次に、createFromMethodNameを使ってgetFullNameメソッドのReflectionMethodオブジェクトを作成し、メソッド名、所属クラス、publicメソッドであるか、パラメータ数とその型などの情報を取得・表示しています。さらに、privateメソッドであるisValidAgeについても同様にReflectionMethodオブジェクトを作成し、privateメソッドであることや戻り値の型を確認できることを示しています。これにより、アクセス修飾子に関わらず、メソッド名を指定するだけでメソッドの情報を調べられることがわかります。もし指定したクラスやメソッドが存在しない場合は、ReflectionExceptionが発生し、エラーメッセージが表示されます。この機能は、プログラムの挙動を解析したり、柔軟な処理を実装したりするのに役立ちます。