New in Symfony 6.1: Service Decoration Attributes




Contributed by
Hubert Lenoir
and Robin Chalas

in #45834,
#46112.

The decorator pattern is a design pattern that allows to modify the behavior
of an individual object without affecting the behavior of other objects from the
same class. In Symfony applications, service decoration allows you to change
the behavior of some service without replacing it or modifying it for other parts
of the application.

You can already configure service decoration using YAML, XML and PHP. In Symfony 6.1
we’re adding the option to configure decoration using PHP attributes.

Consider the common case where you want to decorate a service (e.g. Mailer)
with a new service that adds logging capabilities to it (e.g. LoggingMailer).
This is how you can configure decoration with PHP attributes:

// src/Mailer/LoggingMailer.php
namespace AppMailer;

// …
use SymfonyComponentDependencyInjectionAttributeAsDecorator;

#[AsDecorator(decorates: Mailer::class)]
class LoggingMailer
{
// …
}

The #[AsDecorator] attribute support all the extra options that you might need:

// …

#[AsDecorator(
decorates: Mailer::class,
priority: 10,
onInvalid: ContainerInterface::IGNORE_ON_INVALID_REFERENCE,
)]
class LoggingMailer
{
// …
}

If you need to access the decorated service inside the decorating one, add the
#[MapDecorated] attribute to any of the service constructor arguments:

// …
use SymfonyComponentDependencyInjectionAttributeAsDecorator;
use SymfonyComponentDependencyInjectionAttributeMapDecorated;

#[AsDecorator(decorates: Mailer::class)]
class LoggingMailer
{
public function __construct(#[MapDecorated] Mailer $originalMailer)
{
// …
}

// …
}

Sponsor the Symfony project.

Symfony Blog
Read More

Latest News

PHP-Releases

PHP 8.0.23 released!

PHP 8.1.10 released!

PHP 7.4.30 released!