Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

isBuiltinメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

isBuiltinメソッドは、PHPのリフレクションAPIにおけるReflectionNamedTypeクラスに属し、特定の型宣言がPHPの「組み込み型」であるかどうかを判定するメソッドです。

ReflectionNamedTypeクラスは、関数やメソッドの引数、戻り値、またはプロパティなどで宣言された型の情報を扱うためのクラスです。例えば、string型やint型、あるいは独自に定義したクラス名などが型宣言として指定された際に、その型に関する情報を取得できます。

このisBuiltinメソッドは、対象の型がPHPに標準で備わっている型、すなわち「組み込み型」(ビルトイン型)である場合にtrueを返します。組み込み型には、string(文字列)、int(整数)、float(浮動小数点数)、bool(真偽値)といったスカラー型や、array(配列)、object(オブジェクト)、callable(コールバック)、iterable(イテレータ)、resource(リソース)などが含まれます。一方、プログラマーが独自に定義したクラスやインターフェースの型である場合はfalseを返します。

このメソッドを利用することで、例えばプログラムが実行時に動的に型情報を分析する際、その型がPHPの基本的なデータ型なのか、それともアプリケーション固有の複雑な型なのかを区別できるようになります。これにより、より柔軟な型バリデーションや、コード生成ツール、ドキュメント生成ツールなどの開発において、型に応じた適切な処理を実装するのに役立ちます。PHP 8以降の強化された型システムと組み合わせることで、型の安全性を高めるための強力な手段となります。

構文(syntax)

1<?php
2
3// ReflectionNamedType クラスのインスタンスを取得する例
4// ここでは、関数の引数の型リフレクション情報を使います。
5function myFunction(string $param) {}
6
7$reflectionFunction = new ReflectionFunction('myFunction');
8$parameter = $reflectionFunction->getParameters()[0];
9
10// ReflectionType オブジェクト(ここでは ReflectionNamedType)を取得
11// 型宣言がない場合は null が返るため、 instanceof でチェックします。
12$reflectionNamedType = $parameter->getType();
13
14// isBuiltin() メソッドの構文
15if ($reflectionNamedType instanceof ReflectionNamedType) {
16    $isBuiltinType = $reflectionNamedType->isBuiltin();
17}
18
19?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

bool

このメソッドは、対象となる型がPHPに組み込まれた型(int、string、boolなど)であるかどうかを示す真偽値(boolean)を返します。組み込み型であれば true を、ユーザー定義型であれば false を返します。

サンプルコード

PHPの型が組み込み型か判定する

1<?php
2
3/**
4 * ReflectionNamedType::isBuiltin() の使用例を示します。
5 * このメソッドは、PHPの型が組み込み型(例: int, string, bool, array など)であるかどうかを判定します。
6 *
7 * システムエンジニアを目指す初心者の方にも分かりやすいように、
8 * 組み込み型とユーザー定義型の両方で判定結果を確認します。
9 */
10class TypeBuiltinChecker
11{
12    // 組み込み型のプロパティを定義
13    public bool $status;
14    public string $name;
15
16    // ユーザー定義型のプロパティを定義 (このクラス自体)
17    public TypeBuiltinChecker $selfReference;
18
19    public function __construct()
20    {
21        $this->status = false;
22        $this->name = "Sample";
23        $this->selfReference = $this;
24    }
25
26    /**
27     * boolean型を返すメソッド。boolはPHPの組み込み型です。
28     */
29    public function getStatus(): bool
30    {
31        return $this->status;
32    }
33
34    /**
35     * 文字列型を引数に取るメソッド。stringはPHPの組み込み型です。
36     */
37    public function processName(string $inputName): void
38    {
39        $this->name = $inputName;
40    }
41
42    /**
43     * Reflection APIを使って、様々な型の組み込み判定結果を表示します。
44     */
45    public function demonstrateIsBuiltin(): void
46    {
47        echo "--- ReflectionNamedType::isBuiltin() デモンストレーション ---" . PHP_EOL;
48        echo "この例では、PHPの型が組み込み型(bool, stringなど)か、" . PHP_EOL;
49        echo "それともユーザー定義型(このクラス TypeBuiltinCheckerなど)かを判定します。" . PHP_EOL . PHP_EOL;
50
51        // 現在のクラスのReflectionClassインスタンスを取得
52        $reflectionClass = new ReflectionClass($this);
53
54        // 1. プロパティ 'status' (型: bool) の判定
55        $statusProperty = $reflectionClass->getProperty('status');
56        $statusType = $statusProperty->getType(); // ReflectionNamedType のインスタンスを取得
57        if ($statusType instanceof ReflectionNamedType) {
58            $this->printTypeInfo('プロパティ "status"', $statusType);
59            echo "  (キーワード 'isbool' に関連して、'bool'型はPHPの組み込み型です。)" . PHP_EOL;
60        }
61        echo PHP_EOL;
62
63        // 2. プロパティ 'name' (型: string) の判定
64        $nameProperty = $reflectionClass->getProperty('name');
65        $nameType = $nameProperty->getType();
66        if ($nameType instanceof ReflectionNamedType) {
67            $this->printTypeInfo('プロパティ "name"', $nameType);
68        }
69        echo PHP_EOL;
70
71        // 3. プロパティ 'selfReference' (型: TypeBuiltinChecker) の判定
72        $selfRefProperty = $reflectionClass->getProperty('selfReference');
73        $selfRefType = $selfRefProperty->getType();
74        if ($selfRefType instanceof ReflectionNamedType) {
75            $this->printTypeInfo('プロパティ "selfReference"', $selfRefType);
76            echo "  (このクラス 'TypeBuiltinChecker' はユーザーが定義した型なので、組み込み型ではありません。)" . PHP_EOL;
77        }
78        echo PHP_EOL;
79
80        // 4. メソッド 'getStatus' の戻り値 (型: bool) の判定
81        $method = $reflectionClass->getMethod('getStatus');
82        $returnType = $method->getReturnType();
83        if ($returnType instanceof ReflectionNamedType) {
84            $this->printTypeInfo('メソッド "getStatus" の戻り値', $returnType);
85        }
86        echo PHP_EOL;
87
88        // 5. メソッド 'processName' の引数 'inputName' (型: string) の判定
89        $method = $reflectionClass->getMethod('processName');
90        $parameters = $method->getParameters();
91        if (!empty($parameters)) {
92            $paramType = $parameters[0]->getType(); // 最初の引数の型を取得
93            if ($paramType instanceof ReflectionNamedType) {
94                $this->printTypeInfo('メソッド "processName" の引数 "inputName"', $paramType);
95            }
96        }
97    }
98
99    /**
100     * 型情報と isBuiltin() の結果を整形して出力するヘルパーメソッド。
101     *
102     * @param string $description 型の対象を説明する文字列
103     * @param ReflectionNamedType $type 判定対象の ReflectionNamedType インスタンス
104     */
105    private function printTypeInfo(string $description, ReflectionNamedType $type): void
106    {
107        echo "{$description} の型は '{$type->getName()}' です。" . PHP_EOL;
108        // isBuiltin() メソッドを呼び出し、型が組み込み型かチェック
109        echo "  これは組み込み型ですか? " . ($type->isBuiltin() ? 'はい (true)' : 'いいえ (false)') . PHP_EOL;
110    }
111}
112
113// TypeBuiltinChecker クラスのインスタンスを作成し、デモンストレーションを実行します。
114$checker = new TypeBuiltinChecker();
115$checker->demonstrateIsBuiltin();
116

このサンプルコードは、PHPのReflectionNamedType::isBuiltin()メソッドの利用例です。このメソッドは、プロパティやメソッドの引数、戻り値などで取得した型が、PHPに元から備わっている「組み込み型」(例: int, string, bool)であるかを判定します。引数はなく、判定結果として真偽値(trueまたはfalse)を返します。

コードでは、TypeBuiltinCheckerクラス内で定義されたboolやstringなどの組み込み型のプロパティ、およびTypeBuiltinChecker自身のユーザー定義型のプロパティを対象に、リフレクションAPIを用いて型情報を取得しています。取得した各型情報に対してisBuiltin()を呼び出し、それが組み込み型であるかどうかの判定結果を出力します。

具体的には、bool型やstring型に対してはtrueが、ユーザー定義型のTypeBuiltinCheckerに対してはfalseが返されます。キーワード「isbool」からも示されるように、bool型はPHPの組み込み型の一つです。この例により、PHPの実行時に型の種類を動的に判別する基本的な方法を理解できます。

ReflectionNamedType::isBuiltin()メソッドは、PHPの型がint、string、bool(キーワードisboolに関連)などの組み込み型であるかを判定します。この機能は、通常、フレームワークやライブラリ開発、コード解析といった高度な場面で型の詳細を調べる際に利用されます。サンプルコードのように型情報を取得する際は、getType()の戻り値がnullでないことと、ReflectionNamedTypeのインスタンスであることを必ず確認してください。Union型などの複合型では直接利用できないため、適切な型チェックが必要です。戻り値が真偽値なので、その結果に基づき安全に処理を分岐させることが重要です。

PHP リフレクションで組み込み型を判定する

1<?php
2
3/**
4 * 型の情報を取得し、それがPHPの組み込み型(int, string, boolなど)であるかを確認する関数です。
5 * システムエンジニアを目指す初心者向けに、リフレクションの基本的な使い方と
6 * ReflectionNamedType::isBuiltin() の動作を示します。
7 */
8function demonstrateBuiltinTypeCheck(): void
9{
10    // 検証用の関数を定義します。
11    // この関数は、組み込み型とユーザー定義型の両方を引数と戻り値に持ちます。
12    // bool型が含まれていることに注目してください。
13    /**
14     * @param string $name
15     * @param int $age
16     * @param bool $isActive
17     * @return stdClass
18     */
19    $myTestFunction = function (string $name, int $age, bool $isActive): stdClass {
20        $result = new stdClass();
21        $result->name = $name;
22        $result->age = $age;
23        $result->isActive = $isActive;
24        return $result;
25    };
26
27    try {
28        // 定義した関数をリフレクションAPIで検査します。
29        $reflectionFunction = new ReflectionFunction($myTestFunction);
30
31        echo "--- 関数パラメータの型チェック ---\n";
32        // 関数の各パラメータについて、その型が組み込み型か確認します。
33        foreach ($reflectionFunction->getParameters() as $parameter) {
34            $type = $parameter->getType(); // パラメータの型情報を取得
35
36            // 型情報が存在し、かつReflectionNamedTypeのインスタンスであるかを確認します。
37            // ReflectionNamedTypeは「string」「int」「bool」「MyClass」などの名前付き型を表します。
38            if ($type instanceof ReflectionNamedType) {
39                $typeName = $type->getName();
40                // isBuiltin() メソッドを使って、型が組み込み型か判定します。
41                $isBuiltin = $type->isBuiltin();
42
43                echo "パラメータ名: '{$parameter->getName()}', ";
44                echo "型: '{$typeName}', ";
45                echo "組み込み型: " . ($isBuiltin ? 'はい' : 'いいえ') . "\n";
46            } else {
47                echo "パラメータ名: '{$parameter->getName()}', 型: 不明または複合型\n";
48            }
49        }
50
51        echo "\n--- 関数戻り値の型チェック ---\n";
52        // 関数の戻り値の型について、それが組み込み型か確認します。
53        $returnType = $reflectionFunction->getReturnType();
54
55        if ($returnType instanceof ReflectionNamedType) {
56            $typeName = $returnType->getName();
57            $isBuiltin = $returnType->isBuiltin();
58
59            echo "戻り値の型: '{$typeName}', ";
60            echo "組み込み型: " . ($isBuiltin ? 'はい' : 'いいえ') . "\n";
61        } else {
62            echo "戻り値の型: 不明または複合型\n";
63        }
64
65    } catch (ReflectionException $e) {
66        echo "リフレクションエラー: " . $e->getMessage() . "\n";
67    }
68}
69
70// 関数を実行して、結果を出力します。
71demonstrateBuiltinTypeCheck();
72

PHP 8のReflectionNamedType::isBuiltin()メソッドは、プログラム実行中に型情報を動的に調べる「リフレクションAPI」の機能です。このメソッドは、対象の型がPHPに標準で組み込まれている「組み込み型」であるかを判定します。

組み込み型とは、int(整数)、string(文字列)、bool(真偽値)など、PHPが元から持つ基本的なデータ型を指します。isBuiltin()に引数はなく、呼び出すと、対象の型が組み込み型であればtrue、そうでなければfalseという真偽値(bool型)を戻り値として返します。

サンプルコードでは、string、int、bool型を引数に、stdClassを戻り値に持つ関数を例に、本メソッドの動作を示します。関数の各パラメータの型を調べると、string、int、boolは組み込み型として「はい」と判定されます。一方で、戻り値のstdClassは組み込み型ではないため「いいえ」と判定されることが確認できます。この機能は、実行時に型の種類に応じて処理を変えたい場合に活用できます。

このコードは、ReflectionNamedType::isBuiltin()を使って、PHPの型が組み込み型であるかを確認する方法を示します。isBuiltin()はint、string、boolといったプリミティブ型にはtrueを返しますが、stdClassのような組み込みクラス名にはfalseを返します。これは、isBuiltin()がプリミティブな型キーワードの判定に特化しているためです。getType()は常に型情報を返すとは限らず、nullや複合型(ReflectionUnionTypeなど)の可能性もあるため、ReflectionNamedTypeのインスタンスであるか必ず確認しましょう。リフレクション操作は例外を発生させる場合があるので、try-catchでエラーハンドリングを行うことも重要です。

関連コンテンツ

関連IT用語

関連プログラミング言語