New in Symfony 6.1: Simpler Bundle Extension and Configuration

Contributed by Yonel Ceruto in #43701.

Symfony bundles provide ready-to-use features to Symfony applications. In some cases, bundles include their own configuration and can even extend the application configuration adding new options. These extension and configuration features are implemented via dedicated classes that extend/implement other Symfony classes. This process is well-known and not complicated, but it's a bit verbose and cumbersome. That's why in Symfony 6.1 we're introducing a simpler way to configure and extend bundles. This is the biggest change we ever made to the bundle system and you'll love it. In Symfony 6.1, you can define the configuration and extension of a bundle directly in the main bundle class, without creating any other classes. Let's consider a Foo bundle that defines the following main bundle class:

    namespace Acme\Bundle\FooBundle;

use Symfony\Component\HttpKernel\Bundle\Bundle;

class FooBundle extends Bundle { }

First, you need to change its base class to the new AbstractBundle:

    // ...

use Symfony\Component\HttpKernel\Bundle\AbstractBundle;

class FooBundle extends AbstractBundle { }

Now, do you want to define semantic configuration for this bundle? Forget about the Configuration class, the TreeBuilder object, the "extension alias", etc. Just define a configure() method in your bundle class:

    class FooBundle extends AbstractBundle

{ // ...

public function configure(DefinitionConfigurator $definition): void
{
    // loads config definition from a file
    $definition->import('../config/definition.php');

    // loads config definition from multiple files (when it's too long you can split it)
    $definition->import('../config/definition/*.php');

    // if the configuration is short, consider adding it in this class
    $definition->rootNode()
        ->children()
            ->scalarNode('foo')->defaultValue('bar')->end()
        ->end()
    ;
}

}

The root key of your bundle configuration is automatically determined from your bundle name (for FooBundle it would be foo). If you want to change it, now you can simply define the following property in the bundle class:

    class FooBundle extends AbstractBundle

{ protected string $extensionAlias = 'acme';

// ...

}

Finally, if you want to configure your bundle extension or to append/prepend configuration options in the application, you no longer need to define an Extension class, use the XmlFileLoader and FileLocator to load configuration files, etc. Define the loadExtension() and/or prependExtension() methods in your bundle and that's all:

    class FooBundle extends AbstractBundle

{ // ...

// $config is the bundle Configuration that you usually process in
// ExtensionInterface::load() but already merged and processed
public function loadExtension(array $config, ContainerConfigurator $container, ContainerBuilder $builder): void
{
    $container->parameters()->set('foo', $config['foo']);
    $container->import('../config/services.php');

    if ('bar' === $config['foo']) {
        $container->services()->set(Parser::class);
    }
}

public function prependExtension(ContainerConfigurator $container, ContainerBuilder $builder): void
{
    // prepend some config option
    $builder->prependExtensionConfig('framework', [
        'cache' => ['prefix_seed' => 'foo/bar'],
    ]);

    // append some config option
    $container->extension('framework', [
        'cache' => ['prefix_seed' => 'foo/bar'],
    ])

    // append options defined in some file (using any config format)
    $container->import('../config/packages/cache.php');
}

}

We're beyond excited about this new feature! We hope you like it too and start using it as soon as you upgrade to Symfony 6.1.

                Sponsor the Symfony project.

https://symfony.com/blog/new-in-symfony-6-1-simpler-bundle-extension-and-configuration?utm_source=Symfony%20Blog%20Feed&utm_medium=feed

Creată 3y | 6 mai 2022, 09:20:16


Autentifică-te pentru a adăuga comentarii

Alte posturi din acest grup

A Week of Symfony #962 (June 2–8, 2025)

This week, development activity focused on the upcoming Symfony 7.4 and 8.0 versions, which will deprecate and remove many features. In addition, we published a case study about Yousign. Finally, we'r

8 iun. 2025, 07:50:05 | Symfony
Case study - Yousign: Scaling Trust with Smart, Scalable Architecture

As digital signatures become the norm in modern business, Yousign has established itself as a trusted leader across Europe. Behind its simple, intuitive interface is a powerful technical engine, handl

6 iun. 2025, 07:10:24 | Symfony
SymfonyOnline June 2025 starts next week!

Get ready for the exciting SymfonyOnline June 2025, kicking off in a few days only! There’s still time to register and join the international online Symfony conference—along with pre-conferenc

5 iun. 2025, 10:20:09 | Symfony
A Week of Symfony #961 (May 26 – June 1, 2025)

This week, Symfony released the stable version of Symfony 7.3, which includes lots of amazing new features. We also published the maintenance versions 6.4.22 and 7.2.7.

Symfony development highlights

1 iun. 2025, 08:50:16 | Symfony
New in Symfony 7.3: DX Improvements (part 2)

This is the second part of the blog post showcasing the main DX (developer experience) features introduced in Symfony 7.3. Read the first part of this blog post.

Verify URI Signatures… https://symfon

29 mai 2025, 09:10:19 | Symfony
Symfony 6.4.22 released

Symfony 6.4.22 has just been released. Read the Symfony upgrade guide to learn more about upgrading Symfony and use the SymfonyInsight upgrade reports to detect the code you will need to change in you

29 mai 2025, 09:10:19 | Symfony
Symfony 7.2.7 released

Symfony 7.2.7 has just been released. Read the Symfony upgrade guide to learn more about upgrading Symfony and use the SymfonyInsight upgrade reports to detect the code you will need to change in your

29 mai 2025, 09:10:18 | Symfony