Примеры

Пример #1 Базовые ограниченные значения

<?php

enum SortOrder
{
case
Asc;
case
Desc;
}

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

Функция query() теперь может безопасно работать, зная, что параметр $order гарантированно будет либо вариантом SortOrder::Asc, либо вариантом SortOrder::Desc. Любое другое значение привело бы к исключению TypeError, поэтому проверка ошибок или тестирование не нужны.

Пример #2 Расширенные эксклюзивные значения

<?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 => 'В ожидании',
static::
Active => 'Активный',
static::
Suspended => 'Приостановленный',
static::
CanceledByUser => 'Отменено пользователем',
};
}
}
?>

В этом примере статус пользователя может быть исключительно одним из следующих вариантов: UserStatus::Pending, UserStatus::Active, UserStatus::Suspended или UserStatus::CanceledByUser. Функция может ввести параметр UserStatus и затем принять только эти четыре значения, точка.

У всех четырёх значений есть метод label(), который возвращает удобочитаемую строку. Эта строка не зависит от скалярной эквивалентной строки "machine name", которую можно использовать, например, в поле базы данных или значении выпадающего списка 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
5 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