Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[Doctrine] Add documentation for Enum usage #19169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: 6.4
Choose a base branch
Loading
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions 1 doctrine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1076,6 +1076,7 @@ Learn more
doctrine/multiple_entity_managers
doctrine/resolve_target_entity
doctrine/reverse_engineering
doctrine/use_enum
testing/database

.. _`Doctrine`: https://www.doctrine-project.org/
Expand Down
43 changes: 43 additions & 0 deletions 43 doctrine/use_enum.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Use Enums
=========

PHP 8.1 added native Enumerations, which can be used to define a custom type
and its possible values. Those can be used in association with Doctrine in
order to define a limited set of values availables for an entity property.

First step is to create an enum::

// src/Enum/Suit.php
namespace App\Enum;

enum Suit: string {
case Hearts = 'H';
case Diamonds = 'D';
case Clubs = 'C';
case Spades = 'S';
}

.. note::

Only backed enums can be used with properties as Doctrine use the scalar
equivalent of each value for storing.

When the enum is created, you can use the ``enumType`` parameter of
``#[ORM\Column]`` attribute or use it directly for a more typed property::

// src/Entity/Card.php
namespace App\Entity;

#[Column(type: Types::STRING, enumType: Suit::class)]
public string $suit;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a rare use case to map a property using a BackedEnum and not use it in the model; I wouldn't show this case. I think the above example should be the only one documented.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see your point. I'm quite in favour of showing both even if one use is rare and let developers choose the one that fit to their needs. Maybe we can add a comment to point which is the most common/recommended way ?


// or for a more typed property
#[Column(type: Types::STRING)]
public Suit $suit;

.. caution::

If you use the Symfony Maker bundle to create or update your entities,
there is no EnumType available. It still can be used to generate property
with getter and setter but you will need to update declaration according
to your needs.
Morty Proxy This is a proxified and sanitized view of the page, visit original site.