PHP: Beispiele

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) {
            static::Pending => 'Pending',
            static::Active => 'Active',
            static::Suspended => 'Suspended',
            static::CanceledByUser => 'Canceled by user',
        };
    }
}
?>

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

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

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 1 note

down

php-net at mentordosnerds dot com ¶

1 year ago

Additional use-case examples:
<?php

trait EnumNamesTrait
{
    abstract public static function cases(): array;
    
    public static function names(): array
    {
        return array_map(fn($enum) => $enum->name, static::cases());
    }
}

trait EnumValuesTrait
{
    abstract public static function cases(): array;
    
    public static function values(): array
    {
        return array_map(fn($enum) => $enum->value, static::cases());
    }
}

trait EnumArraySerializableTrait
{
    use EnumNamesTrait;
    use EnumValuesTrait;
    
    public static function array(): array
    {
        return array_combine(static::names(), static::values());
    }
}

trait EnumJsonSerializableTrait
{
    use EnumArraySerializableTrait;
     
    public static function jsonSerialize(): string
    {
        return json_encode(static::array());
    }
}

enum Suit: string
{
    case Clubs = '♣';
    case Diamonds = '♦';
    case Hearts = '♥';
    case Spades = '♠';
 
    use EnumJsonSerializableTrait;
    
    public const DEFAULT = self::Hearts;
    
    public static function default(): static
    {
        return self::DEFAULT;
    }
}

var_dump(
    Suit::cases(),
    Suit::values(), 
    Suit::names(),
    Suit::array(),
    Suit::jsonSerialize(),
    Suit::default(),
);

＋add a note