Beispiele

Beispiel #1 Grundlegende eingeschränkte Werte

<?php
enum SortOrder
{
    case Asc;
    case Desc;
}

function query($fields, $filter, SortOrder $order = SortOrder::Asc)
{
     /* ... */
}

Die Funktion query() kann nun mit der Gewissheit fortfahren, dass $order garantiert entweder SortOrder::Asc oder SortOrder::Desc ist. Jeder andere Wert hätte zu einem TypeError geführt, sodass keine weitere Fehlerkontrolle oder Prüfung erforderlich ist.

Beispiel #2 Erweiterte exklusive Werte

<?php
enum UserStatus: string
{
    case Pending = 'P';
    case Active = 'A';
    case Suspended = 'S';
    case CanceledByUser = 'C';

    public function label(): string
    {
        return match($this) {
            self::Pending => 'Pending',
            self::Active => 'Active',
            self::Suspended => 'Suspended',
            self::CanceledByUser => 'Canceled by user',
        };
    }
}

$status = UserStatus::Suspended;
var_dump($status->label());

In diesem Beispiel kann der Status eines Benutzers einer der folgenden sein: UserStatus::Pending, UserStatus::Active, UserStatus::Suspended oder UserStatus::CancledByUser. Eine Funktion kann als Parameter UserStatus angeben und akzeptiert dann nur diese vier Werte, Punkt.

Alle vier Werte haben eine label()-Methode, die eine von Menschen lesbare Zeichenkette zurückgibt. Diese Zeichenkette ist unabhängig von der skalaren Zeichenkette "machine name", die z. B. in der Spalte einer Datenbank oder in einem HTML-Auswahlfeld verwendet werden kann.

<?php
enum UserStatus: string
{
    case Pending = 'P';
    case Active = 'A';
    case Suspended = 'S';
    case CanceledByUser = 'C';

    public function label(): string
    {
        return match($this) {
            self::Pending => 'Pending',
            self::Active => 'Active',
            self::Suspended => 'Suspended',
            self::CanceledByUser => 'Canceled by user',
        };
    }
}

foreach (UserStatus::cases() as $case) {
    printf(
        "<option value=\"%s\">%s</option>\n",
        htmlentities($case->value),
        htmlentities($case->label())
    );
}