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

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

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

基本的な使い方

getShortNameメソッドは、列挙型（Enum）の短い名前を取得するメソッドです。このメソッドは、PHP 8.1で導入された列挙型に関するリフレクション情報を提供するReflectionEnumクラスに属しています。リフレクションとは、プログラムが自身の構造を調べたり、動的に操作したりする機能のことです。

getShortNameメソッドを呼び出すと、対象となる列挙型（Enum）の名前空間部分を含まない、純粋な列挙型自身の名前が文字列として返されます。例えば、namespace App\Enums; enum OrderStatus { ... }のように定義された列挙型があった場合、このメソッドを実行するとOrderStatusという文字列が得られます。

この機能は、特にログ出力やユーザーインターフェースでの表示、あるいは特定の列挙型を識別する際に、名前空間のプレフィックスを除いた簡潔な名前が必要な場合に役立ちます。完全な名前（名前空間を含む名前）ではなく、より人間にとって読みやすく、簡潔な識別子を得たい場合に利用されることが多いです。このメソッドは常に文字列型の値を返します。

構文(syntax)


1<?php
2
3enum MyEnum {
4    case Foo;
5    case Bar;
6}
7
8$reflectionEnum = new ReflectionEnum(MyEnum::class);
9$shortName = $reflectionEnum->getShortName();
10
11// $shortName には 'MyEnum' が格納されます
12?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このメソッドは、ReflectionEnumオブジェクトが表す列挙型（Enum）の短縮名（short name）を文字列として返します。

サンプルコード

PHP Enumの短い名前を取得する


1<?php
2
3// PHP 8.1以降で導入されたEnum（列挙型）を定義します。
4// ReflectionEnum クラスは PHP 8.1以降で利用可能です。
5enum PaymentStatus
6{
7    case Pending;
8    case Completed;
9    case Failed;
10}
11
12/**
13 * ReflectionEnum::getShortName() メソッドの使用例を示します。
14 * このメソッドは、指定されたEnumクラスの短い名前（名前空間を含まないクラス名）を返します。
15 * システムエンジニアを目指す初心者向けに、Enumのリフレクションについて説明します。
16 */
17function demonstrateReflectionEnumShortName(): void
18{
19    // PaymentStatus Enum のリフレクションオブジェクトを作成します。
20    // ReflectionEnum は、Enumに関する情報（名前、メンバーなど）をプログラムから取得するために使われます。
21    $reflectionEnum = new ReflectionEnum(PaymentStatus::class);
22
23    // getShortName() メソッドを呼び出し、Enumの短い名前を取得します。
24    // 例えば、`MyNamespace\PaymentStatus` というEnumがあった場合、
25    // このメソッドは `PaymentStatus` を返します。
26    $shortName = $reflectionEnum->getShortName();
27
28    // 取得したEnumの短い名前を出力します。
29    echo "Enumの短い名前: " . $shortName . PHP_EOL; // 出力: Enumの短い名前: PaymentStatus
30}
31
32// サンプル関数を実行します。
33demonstrateReflectionEnumShortName();
34

このサンプルコードは、PHP 8.1以降で導入されたEnum（列挙型）に関する情報を取得するReflectionEnumクラスとそのgetShortName()メソッドの使用方法を示しています。Enumは、関連する定数をまとめて定義する際に便利な機能です。

ReflectionEnumクラスは、プログラム実行中にEnumの構造（名前やメンバーなど）を調べたり操作したりするための機能を提供します。その中のgetShortName()メソッドは、特定のEnumクラスの「短い名前」を取得するために使用されます。ここでいう「短い名前」とは、名前空間（例えばMyNamespace\PaymentStatus）が含まれていない、純粋なクラス名（例えばPaymentStatus）のことです。

サンプルコードでは、まずPaymentStatusというEnumを定義しています。次に、このPaymentStatus Enumのリフレクションオブジェクトをnew ReflectionEnum(PaymentStatus::class)として作成します。このオブジェクトを通して、Enumに関する様々な情報にアクセスできるようになります。そして、$reflectionEnum->getShortName()を呼び出すことで、このEnumの短い名前である「PaymentStatus」を取得し、画面に出力しています。

getShortName()メソッドは引数を取りません。戻り値は、取得したEnumの短い名前を表す文字列（string）です。この機能は、ログ出力や動的なUI生成など、Enumの情報をプログラムから利用する際に役立ちます。

このサンプルコードは、PHP 8.1以降のバージョンで動作します。Enum（列挙型）およびReflectionEnumクラスはPHP 8.1で導入された機能のため、それより古いPHPバージョンでは利用できませんのでご注意ください。ReflectionEnum::getShortName()メソッドは、引数なしで呼び出すことで、指定されたEnumクラスの短い名前、つまり名前空間を含まない純粋なクラス名（Enum名）を文字列として返します。リフレクションは、プログラムの実行中にクラスやオブジェクトの情報を動的に取得するための機能です。ReflectionEnumのインスタンスを作成する際は、PaymentStatus::classのように::class定数を使ってEnumの完全なクラス名を文字列として渡してください。このメソッドの戻り値は常に文字列型です。