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

Copy
1<?php
2
3/**
4 * この関数はユーザーが定義したカスタム関数です。
5 *
6 * @param string $name 名前
7 * @return string 挨拶メッセージ
8 */
9function sayHello(string $name): string
10{
11    return "Hello, " . $name . "!";
12}
13
14/**
15 * 関数の種類（ユーザー定義か組み込みか）を判定し、結果を表示する例です。
16 */
17function demonstrateIsUserDefined(): void
18{
19    // ユーザー定義関数 'sayHello' のリフレクションオブジェクトを作成
20    try {
21        $userDefinedReflection = new ReflectionFunction('sayHello');
22
23        // isUserDefined() メソッドを使用して、関数がユーザー定義であるかをチェック
24        if ($userDefinedReflection->isUserDefined()) {
25            echo "関数 'sayHello' はユーザー定義関数です。\n";
26        } else {
27            echo "関数 'sayHello' は組み込み関数です。\n";
28        }
29    } catch (ReflectionException $e) {
30        echo "エラー: 'sayHello' のリフレクション中に問題が発生しました - " . $e->getMessage() . "\n";
31    }
32
33    echo "\n"; // 区切り
34
35    // PHPの組み込み関数 'strlen' のリフレクションオブジェクトを作成
36    try {
37        $builtinReflection = new ReflectionFunction('strlen');
38
39        // isUserDefined() メソッドを使用して、関数がユーザー定義であるかをチェック
40        if ($builtinReflection->isUserDefined()) {
41            echo "関数 'strlen' はユーザー定義関数です。\n";
42        } else {
43            echo "関数 'strlen' は組み込み関数です。\n";
44        }
45    } catch (ReflectionException $e) {
46        echo "エラー: 'strlen' のリフレクション中に問題が発生しました - " . $e->getMessage() . "\n";
47    }
48}
49
50// サンプルコードを実行
51demonstrateIsUserDefined();
52
53?>

PHPのReflectionFunctionAbstract::isUserDefinedメソッドは、指定された関数が「ユーザーによって定義されたもの」か、それとも「PHPに最初から備わっている組み込み関数」かを判別するための機能です。

このメソッドを利用するには、まず調べたい関数名を使ってReflectionFunctionクラスのオブジェクトを作成します。これは、プログラムの実行中にその関数の詳細な情報を取得する「リフレクション」という仕組みです。

isUserDefinedメソッドは引数を一切必要としません。実行すると、その関数がユーザーが書いたコードで定義されていれば真（true）を、PHPのコア機能として提供されているものであれば偽（false）をブール値として返します。

サンプルコードでは、最初にユーザーが独自に定義したsayHello関数に対してこのメソッドを使用しています。sayHelloはユーザー定義なのでtrueを返し、「関数 'sayHello' はユーザー定義関数です。」と表示されます。次に、PHPに組み込まれているstrlen関数についても同様に判定しています。strlenは組み込み関数であるため、falseを返し、「関数 'strlen' は組み込み関数です。」と表示されることが確認できます。

このように、isUserDefinedは、プログラムが動的に関数の種類を識別し、それぞれ異なる処理を実行したい場合などに有効活用できる便利なメソッドです。

Copy
1<?php
2
3/**
4 * ユーザー定義関数の一例。
5 */
6function greetUser(string $name): string
7{
8    return "こんにちは、" . $name . "さん！";
9}
10
11/**
12 * ReflectionFunctionAbstract::isUserDefined メソッドの動作をデモンストレーションする関数。
13 *
14 * この関数は、様々な種類の関数（ユーザー定義、PHP内部、クロージャ、存在しない関数）に対して
15 * ReflectionFunction を使用し、isUserDefined メソッドがどのような結果を返すかを示します。
16 *
17 * キーワード「php isset undefined variable」との関連性としては、
18 * 変数の「定義の有無」をチェックする `isset` や「未定義変数」のエラーと同様に、
19 * `isUserDefined` は「関数の定義がどのソースによるものか」という「定義の性質」を
20 * 動的に確認する機能を提供します。存在しない関数をリフレクトしようとするとエラーが発生し、
21 * これは「未定義の要素を扱おうとする」ことに起因する問題の一例とも言えます。
22 */
23function demonstrateIsUserDefined(): void
24{
25    // テスト対象の関数を配列に格納
26    // - ユーザー定義関数: 開発者がコード内で直接定義したもの
27    // - PHP内部関数: PHPエンジンに組み込まれているビルトイン関数
28    // - クロージャ (無名関数): その場で定義され、変数に代入可能な関数
29    // - 存在しない関数: リフレクションを試みた際にエラーとなる例
30    $functionsToTest = [
31        'greetUser',     // ユーザー定義関数
32        'strlen',        // PHP内部関数
33        'array_map',     // PHP内部関数
34    ];
35
36    // クロージャ（無名関数）もReflectionFunctionのコンストラクタに直接渡してテストできます
37    $myClosure = function (string $message): string {
38        return "クロージャからのメッセージ: " . $message;
39    };
40    $functionsToTest[] = $myClosure;
41
42    // 存在しない関数名を指定した場合の挙動を示すため、これもテスト対象に含めます
43    $functionsToTest[] = 'nonExistentFunction';
44
45    foreach ($functionsToTest as $function) {
46        // 関数の名前（文字列または'Closure'）を取得し、表示に利用
47        $functionName = is_string($function) ? $function : 'Closure';
48
49        try {
50            // ReflectionFunction のインスタンスを作成し、関数に関する情報を取得
51            // 存在しない関数名を指定すると、ここで ReflectionException がスローされます
52            $reflectionFunction = new ReflectionFunction($function);
53
54            // isUserDefined メソッドを呼び出し、関数がユーザー定義かどうかをチェック
55            $isUserDefined = $reflectionFunction->isUserDefined();
56
57            echo "関数 '" . $functionName . "': ";
58            if ($isUserDefined) {
59                echo "はユーザー定義関数です。\n";
60            } else {
61                echo "はPHPの内部関数です。\n";
62            }
63        } catch (ReflectionException $e) {
64            // ReflectionFunction のコンストラクタが例外をスローした場合の処理
65            // これは、指定された関数が存在しない「未定義」の場合によく発生します
66            echo "関数 '" . $functionName . "' のリフレクション中にエラーが発生しました: " . $e->getMessage() . "\n";
67        }
68    }
69}
70
71// デモンストレーションを実行
72demonstrateIsUserDefined();
73

ReflectionFunctionAbstract::isUserDefinedメソッドは、PHPの関数が「開発者自身がコード内で定義したもの（ユーザー定義関数）」なのか、それとも「PHP言語自体に標準で組み込まれているもの（内部関数）」なのかを判別するために使用されます。このメソッドは引数を取らず、戻り値として真偽値（trueまたはfalse）を返します。trueであればユーザー定義関数、falseであれば内部関数であることを示します。

サンプルコードでは、ReflectionFunctionクラスを使って、さまざまな種類の関数（ユーザーが定義したgreetUser、PHP内部関数であるstrlenやarray_map、そして無名関数であるクロージャ）の情報を取得し、それぞれの関数がユーザー定義であるかをisUserDefinedメソッドで確認しています。greetUser関数やクロージャはtrueを返し、PHP内部関数はfalseを返します。

また、存在しない関数名をReflectionFunctionに渡すと、関数が「未定義」であるためエラーが発生します。これは、変数が定義されているかをチェックするissetや、未定義の変数を参照しようとした際にエラーが発生するのと同様に、「定義の有無」や「定義の性質」を確認しようとする際に起こりうる問題の一例です。isUserDefinedは、このようにプログラムが実行中に動的に関数の種類を特定できる機能を提供します。