CoreShop 4 - Extending Frontend Controllers

[JustMe69]

Q	A
Bug report?	yes
Feature request?	no
BC Break report?	no
RFC?	no

I followed documentation
https://docs.coreshop.org/CoreShop/Development/Frontend_Bundle/
an created own class TemplateConfigurator

<?php

declare(strict_types=1);

namespace FrontendBundle\CoreShop\TemplateConfigurator;

use CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfiguratorInterface;

class TemplateConfigurator implements TemplateConfiguratorInterface
{
    public function findTemplate(string $templateName): string
    {
        return sprintf('coreshop/%s.twig', $templateName);
    }
}


    FrontendBundle\CoreShop\TemplateConfigurator\TemplateConfigurator:
        decorates: 'CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfigurator'
        public: true

I created controller IndexController and followed description in
https://docs.coreshop.org/CoreShop/Development/Frontend_Bundle/Controllers
and created controller and configuration as described

my class:

<?php

declare(strict_types=1);

namespace FrontendBundle\CoreShop\Controller;

use CoreShop\Bundle\FrontendBundle\Controller\FrontendController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class IndexController extends FrontendController
{

    public function indexAction(Request $request): Response
    {
        return $this->render($this->getTemplateConfigurator()->findTemplate('Index/index.html'));
    }
}

my configs:

    FrontendBundle\CoreShop\Controller\IndexController:
        public: true
        arguments:
            - '@service_container'

core_shop_frontend:
    controllers:
        index: FrontendBundle\CoreShop\Controller\IndexController

I'm getting error:

The "CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfiguratorInterface" service or alias has been removed or inlined when the container was compiled. You should either make it public, or stop using the container directly and use dependency injection instead.

How to fix that?

[dpfaffenbauer]

You don't need to extend from the FrontendController and use parameter injection instead.

[JustMe69]

Example somewhere?

[dpfaffenbauer]

no, unfortunately not. That is plain Symfony of how to inject things into the controller.

[JustMe69]

same error with

use CoreShop\Bundle\FrontendBundle\Controller\IndexController as BaseController;
use CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfiguratorInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class IndexController extends BaseController
{
    public function __construct(protected TemplateConfiguratorInterface $templateConfigurator, protected $container)
    {
        parent::__construct($this->container);
    }

and

    FrontendBundle\CoreShop\Controller\IndexController:
        public: true
        calls:
            - [setContainer, ['@service_container']]
        tags:
            - 'controller.service_arguments'
            - 'container.service_subscriber'
        arguments:
            - '@CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfiguratorInterface'
            - '@service_container'

[dpfaffenbauer]

use CoreShop\Bundle\FrontendBundle\Controller\IndexController as BaseController;
use CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfiguratorInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class IndexController extends BaseController
{
    public function indexAction(Request $request, TemplateConfiguratorInterface $templateConfigurator): Response
    {
        return $this->render($templateConfigurator->findTemplate('Index/index.html'));
    }

try it like this

[JustMe69]

tried:

Compile Error: Declaration of FrontendBundle\CoreShop\Controller\IndexController::indexAction(Symfony\Component\HttpFoundation\Request $request, CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfiguratorInterface $templateConfigurator): Symfony\Component\HttpFoundation\Response 
must be compatible with CoreShop\Bundle\FrontendBundle\Controller\IndexController::indexAction(Symfony\Component\HttpFoundation\Request $request): Symfony\Component\HttpFoundation\Response

[dpfaffenbauer]

ah sorry, extend from FrontendController and not BaseIndexController

[JustMe69]

use CoreShop\Bundle\FrontendBundle\Controller\FrontendController;
use CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfiguratorInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class IndexController extends FrontendController
{
    public function __construct(protected TemplateConfiguratorInterface $templateConfigurator, protected $container)
    {
        parent::__construct($this->container);
    }


    public function indexAction(Request $request, TemplateConfiguratorInterface $templateConfigurator): Response
    {
//        return $this->render($this->getTemplateConfigurator()->findTemplate('Index/index.html'));
        return $this->render($this->getTemplateConfigurator()->findTemplate('Index/index.html'), ['is_home' => true]);

//        return $this->render('Index/index.html.twig', ['is_home' => true]);
    }
}

    FrontendBundle\CoreShop\Controller\IndexController:
        public: true
        calls:
            - [setContainer, ['@service_container']]
        tags:
            - 'controller.service_arguments'
            - 'container.service_subscriber'
        arguments:
            - '@CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfiguratorInterface'
            - '@service_container'

Still error:

[dpfaffenbauer]

use CoreShop\Bundle\FrontendBundle\Controller\FrontendController;
use CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfiguratorInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class IndexController extends FrontendController
{
    public function indexAction(Request $request, TemplateConfiguratorInterface $templateConfigurator): Response
    {
        return $this->render($templateConfigurator->findTemplate('Index/index.html'), ['is_home' => true]);
    }
}

    FrontendBundle\CoreShop\Controller\IndexController:
        public: true
        calls:
            - [setContainer, ['@service_container']]
        tags:
            - 'controller.service_arguments'
            - 'container.service_subscriber'

[JustMe69]

Sorry,
still the same error

The "CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfiguratorInterface" service or alias has been removed or inlined when the container was compiled. You should either make it public, or stop using the container directly and use dependency injection instead.

[JustMe69]

I have the solution

Docs saying for own class 'TemplateConfigurator' configuration is needed as followed:

# config/services.yaml
services:
  App\CoreShop\TemplateConfigurator\TemplateConfigurator:
    decorates: 'CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfigurator'

I have to use:

services:
    CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfiguratorInterface:
        class: FrontendBundle\CoreShop\TemplateConfigurator\TemplateConfigurator
        public: true

    FrontendBundle\CoreShop\TemplateConfigurator\TemplateConfigurator:
        decorates: 'CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfigurator'
        public: true

Without the first 3 lines of configuration above, error is always shown:

The "CoreShop\Bundle\FrontendBundle\TemplateConfigurator\TemplateConfiguratorInterface" service or alias 
has been removed or inlined when the container was compiled. You should either make it public, 
or stop using the container directly and use dependency injection instead.

Now frontend is showing up, with own IndexController:

<?php

declare(strict_types=1);

namespace FrontendBundle\CoreShop\Controller;

use CoreShop\Bundle\FrontendBundle\Controller\FrontendController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class IndexController extends FrontendController
{

    public function indexAction(Request $request): Response
    {
        return $this->render($this->getTemplateConfigurator()->findTemplate('Index/index.html'));
    }

}

and config:

core_shop_frontend:
    controllers:
        index: FrontendBundle\CoreShop\Controller\IndexController

and config:

    FrontendBundle\CoreShop\Controller\IndexController:
        public: true
        tags:
            - 'controller.service_arguments'
            - 'container.service_subscriber'
        arguments:
          [ '@Psr\Container\ContainerInterface' ]

I suggest to change documentation.

[JustMe69]

@dpfaffenbauer please mark my last comment as accepted answer and this discussion as resolved if it's fine with you, thanks.

[dpfaffenbauer]

thanks @JustMe69