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

Copy
1<?php
2
3/**
4 * カスタム関数を定義します。
5 * これはPHPの内部関数ではなく、ユーザーが定義した関数です。
6 *
7 * @param mixed $value 評価する値
8 * @return bool 値が文字列であれば true
9 */
10function isMyCustomStringFunction(mixed $value): bool
11{
12    return is_string($value);
13}
14
15// ReflectionFunctionAbstract::isInternal メソッドの使用例
16
17// PHPの組み込み関数 'is_string' をリフレクションで取得
18// 'is_string' はPHPエンジンに組み込まれている内部関数です。
19$reflectionIsString = new ReflectionFunction('is_string');
20
21// isInternal() を呼び出し、関数が内部関数かどうかを判定します。
22// 'is_string' の場合、これは true を返します。
23echo "関数 'is_string' はPHPの内部関数ですか？: ";
24echo $reflectionIsString->isInternal() ? 'はい' : 'いいえ';
25echo PHP_EOL;
26
27// ユーザー定義関数 'isMyCustomStringFunction' をリフレクションで取得
28// この関数はPHPコードで書かれており、内部関数ではありません。
29$reflectionMyFunction = new ReflectionFunction('isMyCustomStringFunction');
30
31// isInternal() を呼び出し、関数が内部関数かどうかを判定します。
32// 'isMyCustomStringFunction' の場合、これは false を返します。
33echo "関数 'isMyCustomStringFunction' はPHPの内部関数ですか？: ";
34echo $reflectionMyFunction->isInternal() ? 'はい' : 'いいえ';
35echo PHP_EOL;
36
37?>

PHP 8のReflectionFunctionAbstract::isInternalメソッドは、指定した関数がPHPの「内部関数」か、あるいは「ユーザー定義関数」かを判定するために使用します。内部関数とは、is_stringのようにPHPエンジンに標準で組み込まれている関数を指し、ユーザー定義関数は、私たちがPHPコード内で独自に作成した関数を指します。

このメソッドは引数を必要とせず、真偽値（bool）を戻り値として返します。対象の関数が内部関数であればtrueを、ユーザー定義関数であればfalseを返します。

サンプルコードでは、PHPの組み込み関数であるis_stringに対してisInternal()を呼び出すとtrueが返され、これはis_stringが内部関数であることを示しています。一方、ユーザーが独自に定義したisMyCustomStringFunctionに対してisInternal()を呼び出すとfalseが返され、この関数が内部関数ではないことを示しています。このように、プログラムで動的に関数の起源を判別したい場合に役立つメソッドです。

Copy
1<?php
2
3/**
4 * ユーザー定義関数の一例。
5 * これはPHPの内部関数ではありません。
6 */
7function greetUser(string $name): string
8{
9    return "こんにちは、" . $name . "さん！";
10}
11
12// ReflectionFunctionを使用して、PHPの関数に関する情報を取得します。
13
14// 1. PHPの内部関数（組み込み関数）を調べます。
15//    例: strlen (文字列の長さを返す関数)
16$reflectionStrlen = new ReflectionFunction('strlen');
17echo "関数 'strlen' はPHPの内部関数ですか？ ";
18// isInternal() メソッドは、その関数がPHPコアによって提供される内部関数であれば true を返します。
19var_dump($reflectionStrlen->isInternal()); // true を出力します
20
21echo "--------------------" . PHP_EOL;
22
23// 2. ユーザーが定義した関数を調べます。
24//    例: greetUser (上で定義した関数)
25$reflectionGreetUser = new ReflectionFunction('greetUser');
26echo "関数 'greetUser' はPHPの内部関数ですか？ ";
27// ユーザー定義関数なので false を返します。
28var_dump($reflectionGreetUser->isInternal()); // false を出力します
29
30echo "--------------------" . PHP_EOL;
31
32// 別の内部関数を調べてみましょう。
33// 例: array_map (配列の各要素に関数を適用する関数)
34$reflectionArrayMap = new ReflectionFunction('array_map');
35echo "関数 'array_map' はPHPの内部関数ですか？ ";
36var_dump($reflectionArrayMap->isInternal()); // true を出力します
37
38?>

ReflectionFunctionAbstract::isInternal() メソッドは、PHPの関数に関する詳細な情報を取得するReflectionFunctionクラスのインスタンスを通じて利用できます。このメソッドの主な役割は、指定された関数がPHPに元々組み込まれている「内部関数」であるか、それともプログラマーが独自に定義した「ユーザー定義関数」であるかを判定することです。このメソッドは引数を必要とせず、真偽値（bool）を戻り値として返します。具体的には、PHPのコアによって提供される組み込み関数であればtrueを返し、ユーザーが作成した関数であればfalseを返します。

サンプルコードでは、まずgreetUserというユーザー定義関数を定義しています。その後、ReflectionFunctionクラスを使って、PHPの内部関数であるstrlenやarray_map、そしてユーザー定義関数であるgreetUserの情報を取得し、それぞれに対してisInternal()を呼び出しています。結果として、strlenとarray_mapについてはtrueが出力され、これらがPHPの組み込み関数であることが示されます。一方、greetUserについてはfalseが出力され、これがユーザーによって定義された関数であることが確認できます。このメソッドは、関数の起源をプログラムで識別したい場合に役立ちます。