Sylius php - how to pass cart to twig template (Sylius Template Events)

The default context provider does not provide a cart object. There's only channelContext, currencyContext, localeContext and customerContext.

Is it possible to get cart in twig template using Sylius template events?

For example like this:

sylius_ui:
    events:
        sylius.shop.layout.header.content:
            blocks:
                search:
                    enabled: true
                    template: "@App/Layout/Header/_search.html.twig"
                    priority: 10
                    context:
                        cart: how_to_pass_cart? # <-- How to pass cart

And using it in a template, for example:

{# @App/Layout/Header/_search.html.twig #}
{{ cart.itemsTotal }}

Right now, in the standard template, to display the cart, a render of the order controller is used with template substitution.

https://github.com/Sylius/Sylius/blob/a0ad0d1e4c61ed8ec30bbb39e36184cb910736b2/src/Sylius/Bundle/ShopBundle/Resources/views/Layout/Header/_cart.html.twig#L2

<div class="right aligned column">
    {{ render(url('sylius_shop_partial_cart_summary', {'template': '@SyliusShop/Cart/_widget.html.twig'})) }}
</div>

From my point of view this is not a very good solution. Is there a way to get the cart via context parameter or ContextProvider in twig template?

Solution

Because we will not be able to inject services using the DefaultContextProvider, we can write our own ContextProvider.

Create a file src/ContextProvider/CartContextProvider.php:

<?php
declare(strict_types=1);

namespace App\ContextProvider;

use Sylius\Bundle\UiBundle\ContextProvider\ContextProviderInterface;
use Sylius\Bundle\UiBundle\Registry\TemplateBlock;
use Sylius\Component\Order\Context\CartContextInterface;
use Sylius\Component\Order\Model\OrderInterface;

final class CartContextProvider implements ContextProviderInterface
{
    public function __construct(
        private CartContextInterface $cartContext
    ){}

    public function provide(array $templateContext, TemplateBlock $templateBlock): array
    {
        $templateContext['cart'] = $this->getCart();
        return $templateContext;
    }

    public function supports(TemplateBlock $templateBlock): bool
    {
        return true;
    }

    private function getCart(): OrderInterface
    {
        return $this->cartContext->getCart();
    }
}

services:
    # ...

    App\ContextProvider\CartContextProvider:
        arguments:
            - '@sylius.context.cart'
        tags:
            - { name: sylius.ui.template_event.context_provider }

After this, a cart will become available in any template. This can be checked in the twig template by calling the dump method. For example like this: {{ dump() }}

Or you can use the Twig Extension solution from another answer in this thread.