-
-
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
Open
MrYamous
wants to merge
5
commits into
symfony:6.4
Choose a base branch
from
MrYamous:doctrine/use-enums
base: 6.4
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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; | ||
|
||
// 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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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 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 ?