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

getTraitsメソッドは、PHPの列挙型（Enum）に適用されているトレイトの情報を取得するメソッドです。このメソッドはReflectionEnumクラスに属しており、ReflectionEnumクラスはPHP 8.1で導入されたEnumに関するリフレクション機能を提供します。リフレクションとは、プログラムの実行中にクラスやメソッド、プロパティなどの構造を動的に調べたり操作したりする機能のことです。

トレイトは、PHPのクラスでコードを再利用するための仕組みであり、単一継承の制約を受けずに複数の振る舞いをクラスに取り込むことができます。getTraitsメソッドを実行すると、対象のEnumに適用されているすべてのトレイトについて、それぞれReflectionTraitオブジェクトの配列として返されます。各ReflectionTraitオブジェクトからは、トレイトの名前や定義されているメソッド、プロパティといった詳細な情報をさらに調べることが可能です。これにより、Enumがどのようなトレイトを利用して構成されているかを、プログラムの実行時に確認できるようになります。主に、フレームワークやライブラリ開発において、Enumの動的な解析やコード生成を行う場面で活用されます。

Copy
1<?php
2
3// PHP 8.1 以降で利用可能な列挙型（enum）を定義
4enum MyStatus
5{
6    case ACTIVE;
7    case INACTIVE;
8}
9
10// 列挙型 MyStatus の ReflectionEnum インスタンスを作成
11$reflectionEnum = new ReflectionEnum(MyStatus::class);
12
13// getTraits メソッドを呼び出し、列挙型が使用しているトレイトの情報を取得
14// 戻り値は、トレイト名（string）をキーとし、ReflectionClass オブジェクトを値とする配列
15$traits = $reflectionEnum->getTraits();

引数なし

引数はありません

array<string, ReflectionTrait>

このメソッドは、ReflectionEnumクラスで定義された列挙型（enum）が使用しているトレイト（trait）の情報を、キーがトレイト名、値がReflectionTraitオブジェクトとなる配列として返します。