-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[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
base: 6.4
Are you sure you want to change the base?
Changes from 4 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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\Enum; | ||
|
||
#[Column(type: Types::TEXT, enumType: Suit::class)] | ||
public string $suit; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. There was a problem hiding this comment. Choose a reason for hiding this commentThe 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::TEXT)] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's a single-line value, so it should be |
||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing indentation for cases