Nov 22, 2023 · Nov 22, 2023 · Nov 22, 2023 · Nov 22, 2023 · Nov 22, 2023 · Nov 22, 2023
diff --git a/doctrine.rst b/doctrine.rst
    doctrine/multiple_entity_managers
    doctrine/resolve_target_entity
    doctrine/reverse_engineering
    doctrine/use_enum
    testing/database

 .. _`Doctrine`: https://www.doctrine-project.org/
diff --git a/doctrine/use_enum.rst b/doctrine/use_enum.rst
 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.
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
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 ycerutoNov 22, 2023 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 ContributorAuthor MrYamousNov 22, 2023 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.