Énumérations de base

Les énumérations sont similaires aux classes et partagent les mêmes espaces de noms que les classes, les interfaces et les traits. Elles sont également autochargeables de la même manière. Une énumération définit un nouveau type, qui possède un nombre fixe et limité de valeurs légales possibles.

<?php

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

Cette déclaration crée un nouveau type énuméré nommé Suit, qui a quatre et seulement quatre valeurs légales : Suit::Hearts, Suit::Diamonds, Suit::Clubs, et Suit::Spades. Les variables peuvent être assignées à l'une de ces valeurs légales. Une fonction peut faire l'objet d'une vérification de type par rapport à un type énuméré, auquel cas seules les valeurs de ce type peuvent être transmises.

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

Une énumération peut avoir zéro ou plusieurs définitions de case, sans maximum. Une énumération à zéro cas est syntaxiquement valide, mais plutôt inutile.

Pour les cas d'énumération, les mêmes règles syntaxiques s'appliquent que pour n'importe quel label en PHP, voir les Constantes.

Par défaut, les cas ne sont pas intrinsèquement soutenus par une valeur scalaire. C'est-à-dire que Suit::Hearts n'est pas égal à "0". Au lieu de cela, chaque cas est soutenu par un objet singleton de ce nom. Cela signifie que :

<?php

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

$a === $b; // true

$a instanceof Suit;  // true

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

Cela signifie également que les valeurs de l'énumération ne sont jamais < ou > l'une à l'autre, puisque ces comparaisons ne sont pas significatives pour les objets. Ces comparaisons renvoient toujours false lorsqu'on travaille avec des valeurs d'énumération.

Ce type de cas, sans données connexes, est appelé "cas pur" ou "Pure Case". Une enum qui ne contient que des cas purs est appelée une Enum pure ou "Pure Enum".

Tous les cas purs sont implémentés en tant qu'instances de leur type d'énumération. Le type d'énumération est représenté en interne comme une classe.

Tous les cas ont une propriété en lecture seule, name, qui est le nom sensible à la casse du cas lui-même.

<?php

print Suit::Spades->name;
// Affiche "Spades"
?>

Il est également possible d'utiliser les fonctions defined() et constant() pour vérifier l'existence ou lire un cas d'énumération si le nom est obtenu dynamiquement. Cette méthode est toutefois déconseillée, car l'utilisation d'une Enum avec valeur de base devrait fonctionner pour la plupart des cas d'utilisation.