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

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

作成日: 2025年09月11日更新日: 2026年01月22日

基本的な使い方

__toStringメソッドは、PHPのReflectionUnionTypeクラスにおいて、そのオブジェクトの文字列表現を取得するために実行されるメソッドです。ReflectionUnionTypeクラスは、PHP 8で導入された「Union Types」に関するリフレクション情報、つまりプログラムの実行中に型に関する詳細な情報を調べる機能を提供します。Union Typesとは、変数や引数が複数の異なる型のいずれかをとることを指定する型宣言です。

この__toStringメソッドは、ReflectionUnionTypeクラスのインスタンスが文字列として扱われる際に自動的に呼び出されます。具体的には、このメソッドは、対象となるUnion Typeがどのような型宣言であるかを、例えば「int|string」や「null|array」のような、人間が読みやすい形式の文字列として返します。

この機能は、リフレクションAPIを通じて取得した型情報をデバッグ出力として表示したり、ログに記録したり、あるいはユーザーインターフェースで型情報を表示する際に特に役立ちます。開発者は、ReflectionUnionTypeオブジェクトを直接文字列として出力するだけで、その型情報を簡潔に確認できるようになります。__toStringメソッドは、ReflectionUnionTypeオブジェクトの内容を直感的かつ正確に文字列で表現するための、非常に便利な手段と言えます。

構文(syntax)


1<?php
2
3class MyClass {
4    public function getValue(): int|string|null {
5        return "hello";
6    }
7}
8
9$reflectionMethod = new ReflectionMethod('MyClass', 'getValue');
10$unionType = $reflectionMethod->getReturnType();
11
12echo $unionType;
13
14?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このメソッドは、ReflectionUnionType オブジェクトの文字列表現を返します。この文字列表現は、PHPの型定義におけるユニオン型をそのまま表した文字列となります。

サンプルコード

PHP 8 ReflectionUnionType __toString() を使う


1<?php
2
3/**
4 * ReflectionUnionType::__toString() メソッドの動作を示すサンプルコード。
5 * ユニオン型を持つプロパティの文字列表現を取得します。
6 *
7 * システムエンジニアを目指す初心者の方へ:
8 * PHP 8 で導入された「ユニオン型」は、変数や引数、戻り値が複数の型のいずれかであることを示す型宣言です。
9 * 例えば、`int|string` は、その値が整数または文字列のどちらかであることを意味します。
10 * `ReflectionUnionType` は、リフレクションAPIを通じてこのユニオン型の情報を取得するためのクラスです。
11 * `__toString()` メソッドは、このユニオン型を人間が読みやすい文字列として表現するために使われます。
12 */
13function demonstrateReflectionUnionTypeToString(): void
14{
15    // ユニオン型 (int または string または null) を持つプロパティを持つクラスを定義します。
16    // このクラスは、リフレクションを通じて型情報を取得するために使用されます。
17    class ExampleUnionClass
18    {
19        public int|string|null $data;
20
21        public function __construct(int|string|null $data)
22        {
23            $this->data = $data;
24        }
25    }
26
27    // ExampleUnionClass のリフレクション情報を取得します。
28    // リフレクションは、実行時にクラスやオブジェクトの構造を調べたり変更したりする機能です。
29    $reflectionClass = new ReflectionClass(ExampleUnionClass::class);
30
31    // 'data' プロパティのリフレクション情報を取得します。
32    $reflectionProperty = $reflectionClass->getProperty('data');
33
34    // プロパティの型情報を取得します。
35    // 'data' プロパティはユニオン型なので、ReflectionUnionType のインスタンスが返されます。
36    $type = $reflectionProperty->getType();
37
38    // 取得した型情報が ReflectionUnionType のインスタンスであるかを確認します。
39    if ($type instanceof ReflectionUnionType) {
40        // ReflectionUnionType::__toString() メソッドを呼び出して、
41        // ユニオン型の文字列表現を取得し、出力します。
42        // このメソッドは、ユニオン型を構成するすべての型を '|' で区切った文字列を返します。
43        $unionTypeString = $type->__toString();
44
45        echo "ユニオン型の文字列表現: " . $unionTypeString . PHP_EOL;
46        // 例: "int|string|null" のような出力が期待されます。
47    } else {
48        echo "エラー: 'data' プロパティの型は ReflectionUnionType ではありません。" . PHP_EOL;
49    }
50}
51
52// 上記の関数を実行して、ReflectionUnionType::__toString() の動作を確認します。
53demonstrateReflectionUnionTypeToString();
54
55?>

このコードは、PHP 8以降で利用できる「ユニオン型」の情報を、リフレクション機能を使って文字列として取得する方法を示しています。ユニオン型は、変数やプロパティが複数の型のいずれかであることを宣言するもので、例えばint|stringは「整数または文字列」を意味します。ReflectionUnionTypeは、このユニオン型の構造を実行時に調べるためのクラスです。

サンプルコードでは、まずint|string|nullというユニオン型を持つ$dataプロパティを持つクラスExampleUnionClassを定義しています。次に、プログラムの実行中にクラスやプロパティの情報を調べる「リフレクション」という機能を用いて、$dataプロパティの型情報を取得します。この型情報がReflectionUnionTypeであることを確認した後、__toString()メソッドを実行し、"int|string|null"のようなユニオン型の文字列表現を取得して出力します。これにより、プログラムが動的に型の情報を調べ、その内容を可読な形で確認できるようになります。

この__toString()メソッドは、PHP 8で導入されたユニオン型（例: int|string）の具体的な型定義を文字列として取得するために使われます。ReflectionUnionTypeは、プログラム実行中にクラスやプロパティの情報を動的に調べるリフレクション機能の一部です。このメソッドは、ユニオン型を構成する型を|（パイプ）で区切った文字列として返します。コードを利用する際は、プロパティから取得した型が確実にReflectionUnionTypeのインスタンスであることを、instanceof演算子で確認することが重要です。PHP 8以降の環境でなければ、このユニオン型自体が利用できませんのでご注意ください。

PHP 8: ReflectionUnionTypeの__toString()


1<?php
2
3// Union Type を持つクラスを定義します。
4// PHP 8 で導入された Union Type (例: int|string) は、プロパティや引数が複数の型のいずれかを受け入れることを示します。
5class DataProcessor
6{
7    public int|string $inputData;
8
9    public function __construct(int|string $data)
10    {
11        $this->inputData = $data;
12    }
13}
14
15// ReflectionClass を使って DataProcessor クラスの情報を取得します。
16$reflectionClass = new ReflectionClass(DataProcessor::class);
17
18// 'inputData' プロパティの ReflectionProperty オブジェクトを取得します。
19$reflectionProperty = $reflectionClass->getProperty('inputData');
20
21// プロパティの型情報を ReflectionType オブジェクトとして取得します。
22$reflectionType = $reflectionProperty->getType();
23
24// 取得した型情報が ReflectionUnionType のインスタンスであるかを確認します。
25if ($reflectionType instanceof ReflectionUnionType) {
26    // ReflectionUnionType オブジェクトを文字列として出力します。
27    // PHPでは、オブジェクトが文字列コンテキストで使用されると、__toString() メソッドが自動的に呼び出されます。
28    echo "Property 'inputData' Union Type representation: " . $reflectionType . "\n";
29
30    // 明示的に __toString() メソッドを呼び出すことも可能です。
31    echo "Explicit call to __toString() method: " . $reflectionType->__toString() . "\n";
32} else {
33    // 'inputData' プロパティが Union Type でない、または型情報が取得できなかった場合のメッセージです。
34    echo "The 'inputData' property does not use a Union Type or its type information is unavailable.\n";
35}
36

このサンプルコードは、PHP 8で導入されたUnion Typeの情報を、実行時にプログラム自身が取得し、その文字列表現を確認する方法を示しています。Union Typeとは、一つの変数やプロパティが、複数の異なる型のいずれかを受け入れることができる仕組み（例えばint|string）です。

まず、DataProcessorクラスを定義し、inputDataというプロパティにint|stringというUnion Typeを設定しています。次に、PHPのReflection APIという機能を使用します。Reflection APIは、プログラムの実行中にクラス、メソッド、プロパティなどの構造に関する情報を動的に取得できる強力な機能です。

ReflectionClassを使ってDataProcessorクラス全体の情報を取得し、その中からinputDataプロパティの情報を表すReflectionPropertyオブジェクトを取り出します。このReflectionPropertyオブジェクトからgetType()メソッドを呼び出すと、プロパティの型情報を示すReflectionTypeオブジェクトが得られます。

もし、この型情報がReflectionUnionTypeのインスタンスであれば、そのオブジェクトを文字列として出力しています。ReflectionUnionType::__toString()メソッドは、このReflectionUnionTypeオブジェクトが示すUnion Typeの定義を文字列形式（例えばint|string）で返す役割を持ちます。このメソッドは引数を取らず、戻り値として文字列を返します。PHPでは、オブジェクトが文字列として扱われる文脈で使われた場合、自動的に__toString()メソッドが呼び出されるため、echo $reflectionTypeと記述するだけで結果が得られます。もちろん、$reflectionType->__toString()のように明示的に呼び出すことも可能です。これにより、プログラムの型情報を柔軟に検査し、利用できるようになります。

このメソッドは、PHP 8で導入されたUnion Type（複数の型を許容する記述、例: int|string）の情報を扱うReflectionUnionTypeクラスに備わっています。その役割は、ReflectionUnionTypeオブジェクトが表す型情報を「int|string」といった形式の文字列として取得することです。PHPでは、オブジェクトをechoなどで文字列として扱おうとすると、この__toString()メソッドが自動的に実行されます。もちろん、明示的にメソッドを呼び出すことも可能です。この機能は、プログラムの構造を動的に解析したり、デバッグ情報を表示したりする際に非常に便利です。ただし、プロパティの型がUnion Typeではない場合もあるため、サンプルコードのようにinstanceof演算子を使って、対象がReflectionUnionTypeであることを確認してから利用するようにしましょう。