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

getBackingValueメソッドは、PHPのReflectionEnumBackedCaseクラスに属し、列挙型（Enum）のバッキングケースが持つ具体的なバッキング値を取得するために実行するメソッドです。PHP 8.1以降で導入された列挙型は、特定の意味を持つ定数をグループ化して管理する機能であり、その中でも「バッキングケース」は、列挙型メンバーに文字列や数値といった実際の値を紐付けることができます。

ReflectionEnumBackedCaseクラスは、このようなバッキング値を持つ列挙型の特定のケースについて、プログラムの実行中にその構造や詳細な情報を動的に調査・操作するための「リフレクション」機能を提供します。このgetBackingValueメソッドを利用することで、リフレクション対象である列挙型のバッキングケースに定義されている、具体的な文字列型または整数型のバッキング値を取り出すことが可能になります。

例えば、Status::APPROVEDという列挙型ケースに'approved'という文字列がバッキング値として紐付けられている場合、このメソッドは'approved'という値を返します。これにより、プログラムは実行時に列挙型ケースの持つバッキング値を動的に取得し、その値に基づいて条件分岐を行ったり、データベースに保存する値として利用したりするなど、柔軟な処理を実現できます。システム開発において、列挙型の情報を詳細に解析し、多様な状況でその値を活用したい場合に非常に有効なメソッドです。

Copy
1<?php
2
3enum Status: int
4{
5    case Active = 1;
6}
7
8// ReflectionEnumBackedCase のインスタンスを取得します。
9// これは通常、ReflectionEnum から特定のバック付きケースを取得することで得られます。
10$reflectionEnum = new ReflectionEnum(Status::class);
11/** @var ReflectionEnumBackedCase $reflectionCase */
12$reflectionCase = $reflectionEnum->getCase('Active');
13
14// getBackingValue() メソッドを呼び出して、バック付き列挙型ケースのバッキング値を取得します。
15$backingValue = $reflectionCase->getBackingValue();
16
17?>

引数なし

引数はありません

string|int

このメソッドは、EnumCaseの裏付けとなる値（stringまたはint）を返します。