Grundlagen der Aufzählungen

Enums sind ähnlich wie Klassen und teilen sich die gleichen Namensräume wie Klassen, Schnittstellen und Traits. Sie können auch auf die gleiche Weise automatisch geladen werden. Eine Enum definiert einen neuen Typ, der eine feste, begrenzte Anzahl von möglichen zulässigen Werten hat.

<?php

enum Suit
{
    case Hearts;
    case Diamonds;
    case Clubs;
    case Spades;
}
?>

Diese Deklaration erzeugt einen neuen Aufzählungstyp namens Suit, der genau vier zulässige Werte hat: Suit::Hearts, Suit::Diamonds, Suit::Clubs, und Suit::Spades. Variablen kann einer dieser zulässigen Werte zugewiesen werden. Eine Funktion kann gegen einen Aufzählungstyp typgeprüft werden; in diesem Fall dürfen nur Werte dieses Typs übergeben werden.

<?php

function pick_a_card(Suit $suit)
{
    /* ... */
}

$val = Suit::Diamonds;

// OK
pick_a_card($val);

// OK
pick_a_card(Suit::Clubs);

// TypeError: pick_a_card(): Argument #1 ($suit) must be of type Suit, string given
pick_a_card('Spades');
?>

Eine Aufzählung kann null oder mehr case-Definitionen haben, wobei es kein Maximum gibt. Eine Aufzählung mit null Fällen ist zwar syntaktisch gültig, aber ziemlich nutzlos.

Für Aufzählungsfälle gelten die gleichen Syntaxregeln wie für jedes Label in PHP, siehe Konstanten.

Standardmäßig werden Fälle intern nicht mit einem skalaren Wert verknüpft. Das bedeutet, dass Suit::Hearts nicht gleich "0" ist. Stattdessen wird jeder Fall mit einem Singleton-Objekt mit diesem Namen verknüpft. Der folgende Code veranschaulicht dies:

<?php

$a = Suit::Spades;
$b = Suit::Spades;

$a === $b; // true

$a instanceof Suit;  // true

$a !== 'Spades'; // true
?>

Es bedeutet auch, dass Enum-Werte niemals < oder > sind, da diese Vergleiche bei Objekten keinen Sinn ergeben. Wenn Enum-Werte auf diese Weise verglichen werden, wird immer false zurückgegeben.

Eine solche Art von Fall, der keine zugehörigen Daten enthält, wird als "Pure Case" (reiner Fall) bezeichnet. Eine Enum, die nur reine Fälle enthält, wird als "Pure Enum" bezeichnet.

Alle Pure Cases werden als Instanzen ihres Enum-Typs implementiert. Der Enum-Typ wird intern als Klasse dargestellt.

Alle Fälle haben die schreibgeschützte Eigenschaft name, die den Namen des Falls selbst angibt, wobei zwischen Groß- und Kleinschreibung unterschieden wird.

<?php

print Suit::Spades->name;
// Gibt "Spades" aus
?>

Wenn der Name eines Enum-Falls dynamisch ermittelt wird, ist es auch möglich, die Funktionen defined() und constant() zu verwenden, um zu prüfen, ob es den Enum-Fall gibt, bzw. diesen auszulesen. Davon wird jedoch abgeraten, da die Verwendung von Wertgebundene Aufzählungen (Backed Enums) die meisten Anwendungsfälle abdecken sollte.