New in Symfony 5.4: PHP Enumerations Support

PHP Enumerations, or "PHP enums" for short, is one of the most anticipated new features of PHP 8.1 (released on November 25, 2021). Their most common use case is to group several related values. In previous PHP versions you had to define a series of related constants to achieve that. In PHP 8.1 you can do this:

    1

2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 // Defining the enumeration and its values namespace App\Config;

enum TextAlign { case Left; case Center; case Right; }

// Using the enumeration as a data type use App\Config\TextAlign;

class SomeClass { public function setTextAlignment(TextAlign $alignment) { // ... } }

// Using the enum in action $someObject->setTextAlignment(TextAlign::Center);

PHP Enumerations are modeled as ADT (Algebraic Data Type) values, so they can define methods, implement interfaces, define values, etc. In Symfony 5.4 we've added support for PHP enums in different components.

PHP Enums Support in Symfony Forms

        Contributed by Alexander M. Turek 
        in #43095.

The Form component has added a new EnumType field so you can represent PHP enums as a selection of values. Consider this example:

    1

2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 enum Suit: string { case Hearts = 'H'; case Diamonds = 'D'; case Clubs = 'C'; case Spades = 'S'; }

enum Rank: string { case Ace = 'A'; case King = 'K'; case Queen = 'Q'; case Jack = 'J'; case Ten = 'X'; case Nine = '9'; case Eight = '8'; case Seven = '7'; case Six = '6'; case Five = '5'; case Four = '4'; case Three = '3'; case Two = '2'; }

final class Card { public ?Suit $suit = null; public ?Rank $rank = null; }

Use the new EnumType class to represent these PHP enums as form fields:

    1

2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 // src/Form/Type/CardType.php namespace App\Form\Type;

use App\Config\Suit; use App\Config\Rank; use Symfony\Component\Form\AbstractType; use Symfony\Component\Form\Extension\Core\Type\EnumType; use Symfony\Component\Form\Extension\Core\Type\SubmitType; use Symfony\Component\Form\FormBuilderInterface;

class CardType extends AbstractType { public function buildForm(FormBuilderInterface $builder, array $options): void { $builder ->add('suit', EnumType::class, ['class' => Suit::class, 'expanded' => true]) ->add('rank', EnumType::class, ['class' => Rank::class]) ->add('submit', SubmitType::class) ; }

// ...

}

This is how the form will look like in Symfony 5.4:

PHP Enums Support in Symfony Serializer

        Contributed by Alexandre Daubois 
        in #40830.

PHP enums that define scalar values for their entries are called "backed enums". When properties use that kind of PHP enum, the Symfony Serializer component can normalize and denormalize those properties:

    1

2 3 4 5 6 7 8 9 10 11 final class Card { public Suit $suit; }

$card = new Card(); $card->suit = Suit::Diamonds; $serialized = $this->serializer->serialize($card, 'json') // expected: '{ "suit": "D" }'

$this->serializer->deserialize($serialized, Card::class); // expected: Card->suit === Suit::Diamonds

PHP Enums Support in other components Alexandre Daubois also contributed other Pull Requests to add PHP enums support in other Symfony components: Pull Request #40857 added enums support when dumping the Dependency Injection container; Pull Request #41072 added enums support to VarExporter component. PHP Enumerations are fantastic and Symfony 5.4 will fully support them since day one.

                Sponsor the Symfony project.

http://feedproxy.google.com/~r/symfony/blog/~3/CIp7n31RZdE/new-in-symfony-5-4-php-enumerations-support

Created 4y | Nov 10, 2021, 5:20:32 PM


Login to add comment

Other posts in this group

SymfonyOnline June 2025: FormFlow: Build Stunning Multistep Forms

SymfonyOnline June 2025 is almost here, starting in almost 2 months on:

June 10-11: Workshop days. It is possible to attend 1 two-day training or 2 one-day trainings. June 12-13: Online confe

Apr 23, 2025, 3:20:21 PM | Symfony
New in Symfony 7.3: Assets Pre-Compression

Contributed by Kévin Dunglas in

Apr 23, 2025, 8:20:31 AM | Symfony
SymfonyOnline June 2025: Inside a Financial App Breach: Debugging a Million-Dollar Bug

SymfonyOnline June 2025 is almost here, starting in almost 2 months on:

June 10-11: Workshop days. It is possible to attend 1 two-day training or 2 one-day trainings. June 12-13: Online confe

Apr 22, 2025, 1:50:03 PM | Symfony
New in Symfony 7.3: Invokable Commands and Input Attributes

This is the first article in a series showcasing the most important new features introduced by Symfony 7.3, which will be released at the end of May 2025.

Apr 22, 2025, 9:10:36 AM | Symfony
A Week of Symfony #955 (April 14–20, 2025)

This week, the upcoming Symfony 7.3 version improved the AsAlias attribute by adding a new argument, introduced Clock support for UriSigner, and refined the return type of the ContainerInterface::get(

Apr 20, 2025, 8:30:06 AM | Symfony
SymfonyOnline June 2025: Rethinking File Handling in Symfony

SymfonyOnline June 2025 is almost here, starting in almost 2 months on:

June 10-11: Workshop days. It is possible to attend 1 two-day training or 2 one-day trainings. June 12-13: Online confe

Apr 16, 2025, 4:30:02 PM | Symfony
SymfonyLive Paris 2025: Recap and replay!

SymfonyLive Paris 2025 took place three weeks ago — a big thank you to everyone who joined us! The conference was held entirely in French, and now you can relive the best moments: replays, hig

Apr 15, 2025, 2:50:24 PM | Symfony