Перечисления PHP (enum): from(), tryFrom() и cases()

Перечисление PHP (PHP 8.1+) задаёт тип с фиксированным набором возможных значений, его вариантов: enum Status { case Active; case Banned; }. Вариант используется как Status::Active, а параметр с типом Status ничего другого не примет. Типизированное перечисление, 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";

До перечислений то же самое делали списком строковых констант, и ничто не мешало опечатке вроде 'actve' попасть в базу данных. С Status в качестве типа параметра передать можно только три варианта.

Чистые и типизированные перечисления

Варианты чистого перечисления это только имена. Типизированное перечисление объявляет тип после имени, int или string, и тогда у каждого варианта должно быть уникальное значение этого типа. ->name есть у каждого варианта; ->value только у вариантов типизированного перечисления.

<?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. Чистое перечисление подходит для значений, которые существуют только внутри кода, например состояния парсера.

Преобразование значения через from() и tryFrom()

У типизированных перечислений есть два статических метода, чтобы превратить сохранённое значение обратно в вариант. 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 в режиме по умолчанию Priority::from('5') возвращает Priority::Normal, потому что '5' сначала приводится к 5, Priority::from('5x') это TypeError, а под declare(strict_types=1) любая строка это TypeError. Это касается и tryFrom(): Priority::tryFrom('abc') выбрасывает исключение, а не возвращает null, поэтому ввод из формы для перечисления int сначала проверяйте через 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, и ни один пункт не будет выбран.

Методы, константы и интерфейсы перечислений

У перечислений могут быть методы, статические методы и константы, и они могут реализовывать интерфейсы. Внутри метода $this это текущий вариант, поэтому match ($this) естественный способ привязать данные к каждому варианту. Чего у перечисления быть не может, так это свойств: данные для каждого варианта берутся из методов.

<?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

match сравнивает через ===, а вариант перечисления идентичен только самому себе, поэтому match и перечисления хорошо сочетаются. Если забыть вариант и он дойдёт до 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 и как строки

json_encode() записывает вариант типизированного перечисления как его значение. Чистое перечисление закодировать нельзя, а 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"), а реализовать __toString() перечисления не могут. На обратном пути JSON даёт обычную строку, поэтому превращайте её через from() или tryFrom(), как показано. Подробнее о кодировании в json_encode.

Типичные ошибки с перечислениями

Три ошибки встречаются снова и снова. Вариант никогда не равен своему значению, вариант не может быть ключом массива, а new с перечислением не работает:

<?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: они принимают объекты в качестве ключей.