Register custom AttributeBag through CompilerPass

user_13237308 0
Viewed 173

I am trying to tidy up my session variables by integrating custom AttributBags into the session. In Symfony < 6.0 you were able to inject a custom AttributBag into the session service.

See related questions

However this approach does not work anymore in Symfony >= 6.0. This blog article explains that the session service is deprecated and must now be accessed over the request_stack service. For controllers this works fine.

My current (not working) approach looks like this: Define a custom AttributBag class.

class ShoppingCartBag extends AttributeBag {
    public function __construct(string $storageKey = 'shoppingCart') {
        parent::__construct($storageKey);
    }
}

Add a custom CompilerPass in the Kernel class so that Symfony takes care of all changes while building the container.

class Kernel extends BaseKernel {
    use MicroKernelTrait;

    protected function build(ContainerBuilder $container): void {
        $container->addCompilerPass(new AddShoppingCartBagToSessionService());
    }
}

The custom CompilerPass looks like this.

class AddShoppingCartBagToSessionService implements CompilerPassInterface {

    public function process(ContainerBuilder $container) {
        $container->getDefinition('request_stack') //<- Works, but how to access the session?
            ->addMethodCall('getSession') // How to bridge the gap? This thought does not work. I assume it is because the session is not yet instantiated when the container is build.
            ->addMethodCall('registerBag', [new Reference('App\Session\CustomBag\ShoppingCartBag')]);
    }
}
symfony php
2 Answers

As you correctly assumed, the session does not exist yet when doing this via the compiler pass.

Symfony uses a so called SessionFactory to create the session. So what you can do instead, is decorating the existing session.factory service with your own implementation of the SessionFactoryInterface and add your attribute bag there:

An implementation of this decorated session factory might look like this:

namespace App;

use Symfony\Component\HttpFoundation\Session\SessionFactoryInterface;
use Symfony\Component\HttpFoundation\Session\SessionInterface;

class SessionFactoryWithAttributeBag implements SessionFactoryInterface
{
    public function __construct(private SessionFactoryInterface $delegate)
    {
    }

    public function createSession(): SessionInterface
    {
        $session = $this->delegate->createSession();
        $session->registerBag(new ShoppingCartBag());

        return $session;
    }
}

And then you can decorate the session.factory via the services.yaml:

services:
    App\SessionFactoryWithAttributeBag:
        decorates: session.factory
        arguments: ['@.inner']

Now, whenever a session is created, your custom bag is also registered

user_13892110

That was an important clue, thank you @Spea!

I adopted his idea and created a new decorator for the session service. After some trial and error I found an answer to my problem. The solution looks like this. Notice the actual syntax is slightly different from the answer given by Spea.

Create a custom AttributBag by extending the likewise named class. Be careful to set the name of the attribut bag, not the storage key in constructor. Otherwise Symfony will throw an error when you try to access the ShoppingCartBag.

namepsace App\Session;

use Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag;

class ShoppingCartBag extends AttributeBag {
    public function __construct() {
        parent::__construct();
        $this->setName('shoppingCart');
    }
}

Create a decorator to change the session service's behaviour to get the desired result (include the ShoppingCartBag on each session).

namespace App\Decorator;

use App\Session\ShoppingCartBag;
use Symfony\Component\HttpFoundation\Session\SessionFactoryInterface;
use Symfony\Component\HttpFoundation\Session\SessionInterface;

class SessionFactoryShoppingCartBag implements SessionFactoryInterface {
    public function __construct(private SessionFactoryInterface $delegate) {}

    public function createSession(): SessionInterface {
        $session = $this->delegate->createSession();
        $session->registerBag(new ShoppingCartBag());
        return $session;
    }
}

Then decorate the session service in the services.yml by adding the following piece of code.

services:
    App\Decorator\SessionFactoryShoppingCartBag:
        decorates: session.factory
        arguments: ['@.inner']
user_132373080
Related