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

SymfonyOnline June 2025:  Keynote “Symfony in 2025, Scaling to Zero.”

SymfonyOnline June 2025 is almost here, starting in a few weeks on:

June 10-11: Workshop days. June 12-13: Online conference days in English. All talks will be available for replay as soon as

May 16, 2025, 3:10:26 PM | Symfony
New in Symfony 7.3: Dependency Injection Improvements

Symfony 7.3 introduces several enhancements to the DependencyInjection component that simplify service configuration, make autoconfiguration more flexible, and enable environment-specific aliasing.

S

May 16, 2025, 8:10:11 AM | Symfony
New in Symfony 7.3: Namespaced Caches

Contributed by Nicolas Grekas in

May 15, 2025, 8:50:14 AM | Symfony
SymfonyOnline June 2025: Building an Automated Trading System with Symfony

SymfonyOnline June 2025 is almost here, starting in almost 2 months on:

June 10-11: Workshop days. It is possible to attend 1 two-day training or 2 one-day trainings. June 12-13: Online confe

May 14, 2025, 2:30:11 PM | Symfony
New in Symfony 7.3: Security Improvements

Symfony security includes several significant improvements and new features in Symfony 7.3.

Deprecate eraseCredentials() Method… https://symfony.com/blog/new-in-symfony-7-3-security-improvements?utm_

May 14, 2025, 9:50:05 AM | Symfony
SymfonyOnline June 2025: Demystify the Magic of the Container🪄

SymfonyOnline June 2025 is almost here, starting in almost 2 months on:

June 10-11: Workshop days June 12-13: Online conference days in English. All talks will be available for replay as soon

May 13, 2025, 3:20:17 PM | Symfony
New in Symfony 7.3: ObjectMapper Component

Contributed by Antoine Bluchet in

May 13, 2025, 8:20:10 AM | Symfony