New in Symfony 5.3: Configure Multiple Environments in a Single File

Contributed by Nicolas Grekas in #40214 and #40782.

Symfony defines different configuration environments so you can change your application behavior depending on where it’s run (e.g. locally in your development machine, in the production server, etc.) The options applied to bundles/packages in all environments are defined in config/packages/ and the specific options of each environment are defined in config/packages/<environment>/. This works well, but it’s cumbersome when the differences among environments are minimal, because you need to create/maintain another config file just to change a few config options. That’s why in Symfony 5.3 you can also define options for different environments in a single file. The exact syntax to use depends on the format of the config file. In YAML config files, use the when@... special key: 1 2 3 4 5 6 7 8 9 10 11 12 13 14# config/packages/webpack_encore.yaml webpack_encore:

...

output_path: &#39;%kernel.project_dir%/public/build&#39;
strict_mode: true
cache: false

when@prod: webpack_encore: cache: true

when@test: webpack_encore: strict_mode: false

In XML config, wrap the config in the new <when> tag: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19<!-- config/packages/webpack_encore.xml --> <?xml version="1.0" encoding="UTF-8" ?> <container xmlns="..."> <webpack-encore:config> <!-- ... --> </webpack-encore:config>

    &lt;when env=&quot;prod&quot;&gt;
        &lt;webpack-encore:config&gt;
            &lt;!-- ... --&gt;
        &lt;/webpack-encore:config&gt;
    &lt;/when&gt;

    &lt;when env=&quot;test&quot;&gt;
        &lt;webpack-encore:config&gt;
            &lt;!-- ... --&gt;
        &lt;/webpack-encore:config&gt;
    &lt;/when&gt;
&lt;/container&gt;

In PHP config files, use the new env() method to check in which environment is the application running: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15// config/packages/webpack_encore.php use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return static function (FrameworkConfig $framework, ContainerConfigurator $container) { // ...

if (&#39;prod&#39; === $container-&gt;env()) {
    // ...
}

if (&#39;test&#39; === $container-&gt;env()) {
    $framework-&gt;test(true);
    $framework-&gt;session()-&gt;storageFactoryId(&#39;session.storage.mock_file&#39;);
}

};

This syntax also works to define routes and services only in some environments. You can even combine all in a single file to configure some package and create services but only for some environments: 1 2 3 4 5 6 7 8 9 10 11framework: secret: '%env(APP_SECRET)%'

when@dev: services: App\SomeServiceForDev: ~

when@test: framework: test: true

...

The traditional way of using a config file per environment will keep working in the future, but we encourage you to give this new feature a try to reduce the number of config files to maintain. Lastly, classes can now use PHP attributes to tell that they should only be registered as services in some environments: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16use Symfony\Component\DependencyInjection\Attribute\When;

[When(env: 'dev')]

class SomeClass { // ... }

// you can apply more than one attribute to the same class:

[When(env: 'dev')]

[When(env: 'test')]

class AnotherClass { // ... }

                Sponsor the Symfony project.

http://feedproxy.google.com/~r/symfony/blog/~3/wnRkgGE-l2E/new-in-symfony-5-3-configure-multiple-environments-in-a-single-file

Created 4y | May 7, 2021, 7:20:06 AM


Login to add comment

Other posts in this group

New Core Team Members, 2025 Edition

A few weeks ago, I had the pleasure of announcing the formation of the Symfony UX Core Team, a dedicated group working to enhance the frontend development experience within the Symfony ecosystem. Toda

Feb 24, 2025, 4:20:03 PM | Symfony
SymfonyLive Paris 2025 : Du lego de composants pour un bundle Gotenberg !

SymfonyLive Paris 2025, conference in French language only, will take place from March 27 to 28! The schedule is currently being revealed as we go along. More details are available here.

Al

Feb 24, 2025, 1:50:07 PM | Symfony
A Week of Symfony #947 (17-23 February 2025)

This week, development activity focused on new security features. The upcoming Symfony 7.3 version added support for security voters to explain their vote, improved the IsGranted attribute to allow us

Feb 23, 2025, 10:10:09 AM | Symfony
SymfonyLive Berlin 2025: Agentic Applications with Symfony

SymfonyLive Berlin 2025, conference held in English, will take place from April 1 to 4! The schedule is being revealed gradually. More details are available here.

We’re thrilled to announce

Feb 21, 2025, 9:20:12 AM | Symfony
SymfonyLive Paris 2025 : Postgres pour vos besoins NoSQL

SymfonyLive Paris 2025, conference in French language only, will take place from March 27 to 28! The schedule is currently being revealed as we go along. More details are available here.

Al

Feb 20, 2025, 10:10:13 AM | Symfony
SymfonyLive Berlin 2025: Asynchronous PHP

SymfonyLive Berlin 2025, conference held in English, will take place from April 1 to 4! The schedule is being revealed gradually. More details are available here.

We’re thrilled to announce

Feb 19, 2025, 8:40:05 AM | Symfony
SymfonyLive Paris 2025 :  Le Composant Symfony Mapper

SymfonyLive Paris 2025, conference in French language only, will take place from March 27 to 28! The schedule is currently being revealed as we go along. More details are available here.

Al

Feb 18, 2025, 2:10:24 PM | Symfony