PHP 8.1: Enums (Перечисления)

Статья

Автор: По материалам сайта: link ★ (id:1)
Дата: 2025-11-06 13:18:04

Категории: Программир.; Интернет, сети, web;

<h1>PHP 8.1: Enums (Перечисления)</h1>Встроенная поддержка перечислений добавлена в <a href="https://sergeymukhin.com/blog/chto-novogo-v-php-81" target="_blank">PHP 8.1</a>. Кто-то считает, что перечисления не нужны, а если совсем уж приспичило, то можно воспользоваться сторонними пакетами, как например <a href="https://github.com/spatie/enum" target="_blank">Spatie/Enum</a> , ну а кто-то, в том числе и я, считает, что PHP не хватает нативного функционала по Enums. И я рад, что контрибьютерам PHP удалось наконец-то воплотить это в реальность. Итак, Enumeration или для краткости Enum - это перечислимый тип, который имеет фиксированное количество возможных значений. Например, масти в колоде игральных карт. В колоде есть четыре масти, и они фиксированы: трефы , бубны , черви и пики. В PHP эти масти можно перечислить с помощью Enum:<blockquote>enum Suit {     case Clubs;     case Diamonds;     case Hearts;     case Spades; }</blockquote> С Suit Enum теперь возможно принудительно применять типы при принятии или возврате значения масти:<blockquote>function pick_card(Suit $suit) {}</blockquote><blockquote>pick_card(Suit::Clubs); pick_card(Suit::Diamonds); pick_card(Suit::Hearts); pick_card(Suit::Spades);</blockquote>Или пример использования, что чаще всего мне как раз и приходиться использовать, статусы заказа в интернет-магазине:<blockquote>enum Status {     case CREATED;     case COMPLETED;     case CANCELED; }</blockquote>Теперь в модели заказа Order мы можем использовать статусы следующим образом:<blockquote>class Order {     public function __construct(         public Status $status,      ) {} }</blockquote><blockquote>$post = new Order(Status::CREATED);</blockquote> В отличие от внутреннего использования специальных строк или чисел для хранения и работы с параметрами, перечисления делают код приложения более читабельным и позволяют избежать неожиданного состояния приложения.<h3>Enum синтаксис</h3>PHP 8.1 резервирует и использует ключевое слово enum для объявления Enums. Синтаксис аналогичен синтаксису трейта/класса/интерфейса:<blockquote>enum Status {     case CREATED;     case COMPLETED;     case CANCELED;     case REFUNDED;     case FAILED; }</blockquote><h3>Чувствительность к регистру</h3>Само имя Enum нечувствительно к регистру , и оно соответствует тому, как PHP обрабатывает классы и функции без учета регистра. Отдельные регистры в Enum нечувствительны к регистру.<blockquote>enum Status {     case created;     case Completed;     case canCeleD; }</blockquote><h3>Enum методы </h3>Перечисления могут содержать методы, как и классы. Это очень мощная функция, особенно в сочетании с оператором match:<blockquote>enum Status {     case CREATED;     case COMPLETED;     case CANCELED;     public function color(): string     {         return match($this)          {             Status::CREATED => 'grey',               Status::COMPLETED => 'green',               Status::CANCELED => 'red'        };     } }</blockquote> и далее использовать в коде как:<blockquote>$status = Status::COMPLETED; $status->color(); // "green"</blockquote> Разрешено использовать статические методы. Также обратите внимание, что вы можете использовать в перечислении self:<blockquote>enum Status {     // …          public function color(): string     {         return match($this)          {             self::CREATED => 'grey',                self::COMPLETED => 'green',                self::CANCELED=> 'red',            };     } }</blockquote><h3>Enum интерфейсы    </h3>Перечисления могут реализовывать интерфейсы, как и обычные классы:<blockquote>interface HasColor {     public function color(): string; }</blockquote><blockquote>enum Status implements HasColor {     case CREATED;     case COMPLETED;     case CANCELED;          public function color(): string { /* … */ } }</blockquote> <h3>Перечисления не должны содержать свойств</h3>Одно из наиболее важных различий между Enum и классом заключается в том, что Enums не могут иметь никакого состояния. Объявление или установка свойств не разрешены. Статические свойства также не допускаются. <blockquote>enum Foo {     private string $test;     private static string $test2; } // Fatal error: Enums may not include member variables in ... on line ...</blockquote>Кроме того, не допускается динамическая установка свойств:<blockquote>enum Foo {     case Bar; } $bar = Foo::Bar; $bar->test = 42; // Error: Enum properties are immutable in ...:...</blockquote><h3>  Enum значения  или "Поддерживаемые перечисления"  </h3>Изначально значения Enum представлены внутри объектами, но вы можете присвоить им какое-то значение, например для сериализации их в базу данных.<blockquote>enum Status: string {     case CREATED = 'created';     case COMPLETED = 'completed';     case CANCELED = 'canceled'; }</blockquote>Обратите внимание на объявление типа в определении перечисления. Он указывает, что все значения перечисления имеют данный тип. Вы также можете сделать их целочисленными - int. Обратите внимание, что разрешены только типы int и string, как значения перечисления.  <blockquote>enum Status: int {     case CREATED = 1;     case COMPLETED = 2;     case CANCELED = 3; }</blockquote>Технический термин для такого ввода перечислений называется «поддерживаемые перечисления», поскольку они «подкреплены» более простым значением. Если вы решили присвоить значения перечисления, тогда все варианты должны иметь какое-то значение. Вы не можете смешивать и сочетать их. Перечисления без "поддержки" называются "чистыми перечислениями". <h3>Сериализация поддерживаемых перечислений</h3>Если вы присвоите значения enum, вам вероятно понадобится способ их сериализации и десериализации. Их сериализация означает, что вам нужен способ доступа к значению перечисления. Это делается с помощью public свойства value, обратите внимание, что оно только для чтения:<blockquote>$value = Status::CANCELED->value; // 3</blockquote>Получить перечисление из значения можно с помощью Enum::from <blockquote>$status = Status::from(2); // Status::COMPLETED</blockquote>Также можно использовать tryFrom для возврата null при неизвестном значении. Если бы вы использовали from, то возникло бы исключение. <blockquote>$status = Status::from('unknown'); // ValueError $status = Status::tryFrom('unknown'); // null</blockquote>Вы также можете использовать встроенные функции serialize и unserialize на перечислениях. Кроме того, вы можете использовать json_serialize в сочетании с поддерживаемыми перечислениями, ее результатом будет значение перечисления. Это поведение можно изменить, реализовав JsonSerializable. <h3>Список значений перечисления</h3>Вы можете использовать статический метод cases(), чтобы получить список всех доступных "случаев" в перечислении: Enum::cases()<blockquote>Status::cases(); // [Status::CREATED, Status::COMPLETED, Status::CANCELED]</blockquote><h3>Перечисления - это объекты</h3>Как уже выше упоминалось, значения перечислений представлены как объекты, хотя на самом деле это одноэлементные объекты. Это означает, что вы можете сравнивать их так:<blockquote>$statusA = Status::COMPLETED; $statusB = Status::COMPLETED; $statusC = Status::CANCELED; $statusA === $statusB; // true $statusA === $statusC; // false $statusC instanceof Status; // true</blockquote><h3>Перечисления как ключи массива</h3>Поскольку значения перечислений на самом деле являются объектами, в настоящее время их невозможно использовать в качестве ключей массива. Следующий код приведет к ошибке:<blockquote>$list = [     Status::CREATED => 'created',     // … ];</blockquote>Существует <a href="https://wiki.php.net/rfc/object_keys_in_arrays" target="_blank">RFC</a> для изменения этого поведения, но он еще не был принят.Это означает, что вы можете использовать только перечисления в качестве ключей в SplObjectStorage и WeakMaps. <h3>Перечисления могут иметь ноль или более значений</h3>Внутри структуры enum может содержаться любое количество case от нуля до бесконечности. Оба этих объявления Enum валидны:<blockquote>enum ErrorStates { }</blockquote><blockquote>enum HTTPMethods {     case GET;     case POST; }</blockquote><h3>Создание экземпляров с помощью new запрещено</h3>Хотя кеймы Enum сами по себе являются объектами, их нельзя создавать с помощью конструкции new. Обе следующие new конструкции не допускаются:<blockquote>enum Foo {     case Bar; } new Foo(); // Fatal error: Uncaught Error: Cannot instantiate enum Foo new Foo::Bar(); Parse error: syntax error, unexpected identifier "Bar", expecting variable or "$"</blockquote><h3>Перечисления не могут быть расширены и не должны наследовать</h3>Перечисления объявляются как final, и Enum не может наследоваться от другого Enum или класса.<blockquote>enum Foo extends Bar {} // Parse error: syntax error, unexpected token "extends", expecting "{" in ... on line ...</blockquote><blockquote>enum Foo {} class Bar extends Foo {} // Fatal error: Class Bar may not inherit from final class (Foo) in ... on line ...</blockquote><h3>Запрещенные магические методы </h3>Чтобы объекты Enum не имели какого-либо состояния и чтобы два Enum были сопоставимы, Enum запрещает реализацию нескольких магических методов. Все следующие объявления магических методов недопустимы.<blockquote>enum Foo {     public function __get() {}     public function __set() {}     public function __construct() {}     public function __destruct() {}     public function __clone() {}     public function __sleep() {}     public function __wakeup() {}     public function __set_state() {} } // Fatal error: Enum may not include __get in ... on line ...</blockquote><h3>Рефлексии и атрибуты  </h3>Как и ожидалось, были добавлены несколько классов рефлексии для работы с перечислениями: ReflectionEnum, ReflectionEnumUnitCase и ReflectionEnumBackedCase. Также есть новая функция enum_exists, которая делает то, что предполагает ее название - проверяет является ли переданное значение именем класса Enum.Как и обычные классы и свойства, перечисления и их случаи можно аннотировать с помощью атрибутов . Обратите внимание, что фильтр TARGET_CLASS также будет включать перечисления.И последнее: перечисления имеют свойство только для чтения, которое в RFC упоминается как деталь реализации и, вероятно, должно использоваться только для целей отладки. Однако об этом все же стоит упомянуть. $enum->name

Чтобы написать комментарий нужно, зарегистрироваться

Голосования и тесты: 0

	[16:27]
	[🔒]

Статьи, публикации, обзоры, заметки