Exemples

Exemple #1 Valeurs limitées de base

<?php

enum SortOrder
{
case
Asc;
case
Desc;
}

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

La fonction query() peut maintenant être exécutée en sachant que $order est garanti d'être soit SortOrder::Asc ou SortOrder::Desc. Toute autre valeur aurait entraîné une TypeError, donc aucune autre vérification d'erreur ou test n'est nécessaire.

Exemple #2 Valeurs exclusives avancées

<?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',
};
}
}
?>

Dans cet exemple, le statut d'un utilisateur peut être l'un de, et exclusivement, UserStatus::Pending, UserStatus::Active, UserStatus::Suspended, ou UserStatus::CanceledByUser. Une fonction peut typer un paramètre par rapport à UserStatus et n'accepter que ces quatre valeurs, un point c'est tout.

Ces quatre valeurs ont une méthode label(), qui renvoie une chaîne lisible pour les humains. Cette chaîne est indépendante de la chaîne scalaire équivalente "nom machine", qui peut être utilisée dans, par exemple, un champ de base de données ou un menu déroulant HTML.

<?php

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

add a note

User Contributed Notes 1 note

up
2
php-net at mentordosnerds dot com
6 months 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(),
);
To Top