PHPの列挙型enum：Backed Enum、from()、tryFrom()、cases()

PHPのenum（PHP 8.1以降）は、取りうる値（ケース）の決まった集合を持つ型を定義します：enum Status { case Active; case Banned; }。ケースはStatus::Activeのように使い、Statusで型宣言した引数はそれ以外を受け付けません。Backed Enum（enum Status: string）は、各ケースに保存してStatus::from()で戻せる値も与えます。

<?php
enum Status: string
{
    case Active = 'active';
    case Pending = 'pending';
    case Banned = 'banned';
}

function canLogIn(Status $status): bool
{
    return $status === Status::Active;
}

$s = Status::Pending;
echo $s->name, ' = ', $s->value, "\n";
var_dump(canLogIn($s), canLogIn(Status::Active));

// From a value stored in a database or a form
$fromDb = Status::from('banned');
echo $fromDb->name, "\n";

enumができる前は、同じことを文字列の定数の一覧で書いていて、'actve'のようなタイプミスがデータベースまで届くのを止めるものはありませんでした。引数の型をStatusにすれば、渡せるのは3つのケースだけです。

Pure EnumとBacked Enum

Pure Enumのケースは名前だけです。Backed Enumは名前のあとにintかstringの型を宣言し、すべてのケースがその型の一意な値を持つ必要があります。どのケースにも->nameがあり、->valueがあるのはBackedのケースだけです。

<?php
enum Suit
{
    case Hearts;
    case Spades;
}

enum Priority: int
{
    case Low = 1;
    case Normal = 5;
    case Urgent = 10;
}

$card = Suit::Hearts;
echo $card->name, "\n";
var_dump($card === Suit::Hearts, $card instanceof Suit);

$p = Priority::Urgent;
echo $p->name, ' = ', $p->value, "\n";
var_dump(Priority::Low->value < Priority::Urgent->value);
var_dump($p);

データベースのカラム、URL、フォームの項目、JSONのように、値がプログラムの外に出るならBacked Enumを選びましょう。パーサーの状態のように、コードの中にしか存在しない値ならPure Enumを選びます。

from()とtryFrom()で値を変換する

Backed Enumには、保存した値をケースに戻す2つの静的メソッドがあります。from()は未知の値にValueErrorを投げ、tryFrom()はnullを返すので、既定値のための??と相性がよいです。

<?php
enum Size: string
{
    case Small = 's';
    case Medium = 'm';
    case Large = 'l';
}

var_dump(Size::from('m'));
var_dump(Size::tryFrom('xl'));

$size = Size::tryFrom('xl') ?? Size::Medium;
echo "Using {$size->name}\n";

try {
    Size::from('xl');
} catch (ValueError $e) {
    echo get_class($e), ': ', $e->getMessage(), "\n";
}

ユーザーから送られたものにはtryFrom()を、自分のコードが書いた値にはfrom()を使います。後者では未知の値はバグを意味し、知らせてほしいからです。引数は普通の引数の型ルールに従います。intのenumでは、デフォルトのモードなら'5'が先に5に変換されるのでPriority::from('5')はPriority::Normalを返し、Priority::from('5x')はTypeErrorで、declare(strict_types=1)の下ではどんな文字列もTypeErrorです。tryFrom()も同じで、Priority::tryFrom('abc')はnullを返さずに例外を投げるので、intのenumに対するフォームの入力は先にfilter_var($raw, FILTER_VALIDATE_INT)で確認しましょう。

cases()ですべてのケースを一覧にする

Enum::cases()は、宣言順にすべてのケースの配列を返します。ドロップダウンを作ったり、リストを検証したり、array_columnですべての値を取得したりする方法です。

<?php
enum Plan: string
{
    case Free = 'free';
    case Pro = 'pro';
    case Team = 'team';

    public function label(): string
    {
        return match ($this) {
            Plan::Free => 'Free',
            Plan::Pro => 'Pro, 9 EUR a month',
            Plan::Team => 'Team, 29 EUR a month',
        };
    }
}

$chosen = Plan::tryFrom($_POST['plan'] ?? '');

echo '<form method="post"><select name="plan">';
foreach (Plan::cases() as $plan) {
    $selected = $plan === $chosen ? ' selected' : '';
    echo "<option value=\"{$plan->value}\"$selected>{$plan->label()}</option>";
}
echo '</select> <button>Choose</button></form>';

if ($chosen !== null) {
    echo "<p>You picked <b>{$chosen->name}</b> (stored as '{$chosen->value}').</p>";
}

echo '<pre>', implode(', ', array_column(Plan::cases(), 'value')), '</pre>';

実行してプランを選び、Chooseを押すと、$_POST['plan']に値が入った状態で同じスクリプトがもう一度実行され、tryFrom()が送信された文字列をPlanのケースに戻します。plan=goldのような偽造された値はnullになり、どのオプションも選択されません。

enumのメソッド、定数、インターフェース

enumはメソッド、静的メソッド、定数を持て、インターフェースを実装できます。メソッドの中では$thisが現在のケースなので、各ケースにデータを結びつけるにはmatch ($this)が自然な方法です。enumが持てないのはプロパティで、ケースごとのデータはメソッドから得ます。

<?php
interface HasColor
{
    public function color(): string;
}

enum OrderState: string implements HasColor
{
    case New = 'new';
    case Shipped = 'shipped';
    case Delivered = 'delivered';
    case Cancelled = 'cancelled';

    const DEFAULT = self::New;

    public function color(): string
    {
        return match ($this) {
            self::New => 'blue',
            self::Shipped => 'orange',
            self::Delivered => 'green',
            self::Cancelled => 'grey',
        };
    }

    public function isFinal(): bool
    {
        return in_array($this, [self::Delivered, self::Cancelled], true);
    }

    public static function open(): array
    {
        return array_filter(self::cases(), fn (self $s) => !$s->isFinal());
    }
}

$state = OrderState::DEFAULT;
echo "{$state->name} is {$state->color()}\n";
var_dump(OrderState::Delivered->isFinal());
echo implode(', ', array_map(fn ($s) => $s->name, OrderState::open())), "\n";
var_dump($state instanceof HasColor);

matchでのenum

matchは===で比較し、enumのケースは自分自身とだけ同一なので、matchとenumは相性がよいです。ケースを書き忘れ、そのケースがmatchに届くと、PHPは黙って何も返さない代わりにUnhandledMatchErrorを投げます。

<?php
enum Weekday: int
{
    case Mon = 1;
    case Tue = 2;
    case Wed = 3;
    case Thu = 4;
    case Fri = 5;
    case Sat = 6;
    case Sun = 7;
}

function kind(Weekday $d): string
{
    return match ($d) {
        Weekday::Sat, Weekday::Sun => 'weekend',
        default => 'workday',
    };
}

foreach ([Weekday::Fri, Weekday::Sat, Weekday::from(1)] as $day) {
    echo $day->name, ': ', kind($day), "\n";
}

$tomorrow = Weekday::tryFrom(Weekday::Sun->value + 1) ?? Weekday::Mon;
echo 'After Sun comes ', $tomorrow->name, "\n";

matchとswitchの違いについてはmatchを参照してください。

JSONと文字列でのenum

json_encode()はBackedのケースをその値として書き出します。Pure Enumはエンコードできず、enumは文字列ではなくオブジェクトなので、どのケースもechoでは失敗します。代わりに->valueか->nameを出力しましょう。

<?php
enum Role: string
{
    case Admin = 'admin';
    case Editor = 'editor';
}

$user = ['name' => 'Ada', 'role' => Role::Admin];
echo json_encode($user), "\n";

$data = json_decode('{"name":"Linus","role":"editor"}', true);
$role = Role::from($data['role']);
var_dump($role);

echo 'Role: ' . $role->value . "\n";
echo 'Name: ' . $role->name . "\n";

echo Role::Admin;はError（「Object of class Role could not be converted to string」）を投げ、enumは__toString()を実装できません。戻すときはJSONから普通の文字列が来るので、示したとおりfrom()かtryFrom()で変換します。エンコードについて詳しくはjson_encodeを参照してください。

enumのよくあるミス

何度も出てくるエラーが3つあります。ケースは決してその値と等しくならない、ケースは配列のキーにできない、enumにnewは使えない、の3つです。

<?php
enum Status: string
{
    case Active = 'active';
    case Banned = 'banned';
}

// 1. A case is an object, not its value
var_dump(Status::Active == 'active');          // false
var_dump(Status::Active->value === 'active');  // true

// 2. Use ->value as an array key
$counts = [];
foreach ([Status::Active, Status::Banned, Status::Active] as $s) {
    $counts[$s->value] = ($counts[$s->value] ?? 0) + 1;
}
print_r($counts);

try {
    $bad = [Status::Active => 1];
} catch (TypeError $e) {
    echo 'Array key: ', $e->getMessage(), "\n";
}

// 3. Cases are created by PHP, never with new
try {
    $s = new Status();
} catch (Error $e) {
    echo $e->getMessage(), "\n";
}

ケースそのものをキーにしたマップが必要なら、オブジェクトをキーとして受け付けるSplObjectStorageかWeakMapを使います。