Skip to content

Commit f607a3c

Browse files
committed
Merge branch '6.3' into 6.4
* 6.3: Changing `enum:` example away from APP_ENV
2 parents c39f84a + a809666 commit f607a3c

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

configuration/env_var_processors.rst

+11-6
Original file line numberDiff line numberDiff line change
@@ -745,11 +745,13 @@ Symfony provides the following env var processors:
745745
Tries to convert an environment variable to an actual ``\BackedEnum`` value.
746746
This processor takes the fully qualified name of the ``\BackedEnum`` as an argument::
747747

748-
# App\Enum\Environment
748+
// App\Enum\Suit.php
749749
enum Environment: string
750750
{
751-
case Development = 'dev';
752-
case Production = 'prod';
751+
case Clubs = 'clubs';
752+
case Spades = 'spades';
753+
case Diamonds = 'diamonds';
754+
case Hearts = 'hearts';
753755
}
754756

755757
.. configuration-block::
@@ -758,7 +760,7 @@ Symfony provides the following env var processors:
758760
759761
# config/services.yaml
760762
parameters:
761-
typed_env: '%env(enum:App\Enum\Environment:APP_ENV)%'
763+
suit: '%env(enum:App\Enum\Suit:CARD_SUIT)%'
762764
763765
.. code-block:: xml
764766
@@ -773,14 +775,17 @@ Symfony provides the following env var processors:
773775
https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
774776
775777
<parameters>
776-
<parameter key="typed_env">%env(enum:App\Enum\Environment:APP_ENV)%</parameter>
778+
<parameter key="suit">%env(enum:App\Enum\Suit:CARD_SUIT)%</parameter>
777779
</parameters>
778780
</container>
779781
780782
.. code-block:: php
781783
782784
// config/services.php
783-
$container->setParameter('typed_env', '%env(enum:App\Enum\Environment:APP_ENV)%');
785+
$container->setParameter('suit', '%env(enum:App\Enum\Suit:CARD_SUIT)%');
786+
787+
The value stored in the ``CARD_SUIT`` env var would be a string (e.g. ``'spades'``)
788+
but the application will use the enum value (e.g. ``Suit::Spades``).
784789

785790
.. versionadded:: 6.2
786791

0 commit comments

Comments
 (0)