Enum w PHP: backed enum, from(), tryFrom() i cases()

Enum w PHP (PHP 8.1+) definiuje typ ze stałym zbiorem możliwych wartości, czyli przypadków: enum Status { case Active; case Banned; }. Przypadku używasz jako Status::Active, a parametr z typem Status nie przyjmie niczego innego. Enum backed, enum Status: string, dodatkowo daje każdemu przypadkowi wartość, którą możesz zapisać i przekonwertować z powrotem przez 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";

Przed enumami to samo było listą stałych tekstowych i nic nie powstrzymywało literówki w rodzaju 'actve' przed trafieniem do bazy danych. Z Status jako typem parametru można przekazać tylko trzy przypadki.

Enumy czyste i backed

Enum czysty ma przypadki, które są tylko nazwami. Enum backed deklaruje typ po nazwie, int albo string, a każdy przypadek musi wtedy mieć unikalną wartość tego typu. Każdy przypadek ma ->name; tylko przypadki backed mają ->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);

Wybierz enum backed zawsze, gdy wartość wychodzi poza program: kolumna w bazie danych, adres URL, pole formularza, JSON. Wybierz enum czysty dla wartości istniejących tylko w kodzie, takich jak stan parsera.

Konwersja wartości przez from() i tryFrom()

Enumy backed dostają dwie metody statyczne do zamiany zapisanej wartości z powrotem na przypadek. from() rzuca ValueError dla nieznanej wartości; tryFrom() zwraca null, co dobrze łączy się z ?? dla wartości domyślnej:

<?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";
}

Używaj tryFrom() na wszystkim, co przysłał ci użytkownik, a from() na wartościach zapisanych przez twój własny kod, gdzie nieznana wartość oznacza błąd, o którym chcesz wiedzieć. Argument podlega zwykłym zasadom typów parametrów: w enumie int Priority::from('5') zwraca w trybie domyślnym Priority::Normal, bo '5' jest najpierw zamieniane na 5, Priority::from('5x') to TypeError, a przy declare(strict_types=1) każdy string to TypeError. Dotyczy to też tryFrom(): Priority::tryFrom('abc') rzuca wyjątek zamiast zwrócić null, więc dane z formularza dla enuma int najpierw sprawdź przez filter_var($raw, FILTER_VALIDATE_INT).

Lista wszystkich przypadków przez cases()

Enum::cases() zwraca tablicę wszystkich przypadków w kolejności deklaracji. Tak budujesz listę rozwijaną, walidujesz listę albo pobierasz wszystkie wartości przez 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>';

Uruchom, wybierz plan i naciśnij Choose: ten sam skrypt uruchomi się ponownie z wypełnionym $_POST['plan'], a tryFrom() zamieni przesłany string z powrotem na przypadek Plan. Podrobiona wartość, taka jak plan=gold, daje null i żadna opcja nie jest zaznaczona.

Metody, stałe i interfejsy enumów

Enumy mogą mieć metody, metody statyczne i stałe oraz implementować interfejsy. W metodzie $this to bieżący przypadek, dlatego match ($this) to naturalny sposób na przypisanie danych do każdego przypadku. Enum nie może mieć tylko właściwości: dane przypadków pochodzą z metod.

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

Enumy w match

match porównuje przez ===, a przypadek enuma jest identyczny tylko sam ze sobą, więc match i enumy dobrze do siebie pasują. Jeśli zapomnisz o przypadku, a ten przypadek trafi do match, PHP rzuci UnhandledMatchError zamiast po cichu nic nie zwrócić:

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

Czym match różni się od switch, opisuje strona match.

Enumy w JSON i jako stringi

json_encode() zapisuje przypadek backed jako jego wartość. Enuma czystego nie da się zakodować, a echo dowolnego przypadku kończy się błędem, bo enum to obiekt, a nie string. Zamiast tego wypisz ->value albo ->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; rzuca Error („Object of class Role could not be converted to string”), a enumy nie mogą implementować __toString(). W drugą stronę JSON daje zwykły string, więc przekonwertuj go przez from() albo tryFrom(), jak pokazano. Więcej o kodowaniu na stronie json_encode.

Częste błędy z enumami

Trzy błędy pojawiają się raz po raz. Przypadek nigdy nie jest równy swojej wartości, przypadek nie może być kluczem tablicy, a new nie działa na enumie:

<?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";
}

Jeśli potrzebujesz mapy z kluczami będącymi samymi przypadkami, użyj SplObjectStorage albo WeakMap, które przyjmują obiekty jako klucze.