How to inject different services of the same type via action's parameters?

user_2447596 0
Viewed 71

I have a simple controller with two actions. They have different output format so I want to inject different Formatter implementations in action's parameters. Is there a right way to do that?

class ProductController
{
    private ProductManager $productManager;

    public function __construct(ProductManager $productManager)
    {
        $this->productManager = $productManager;
    }

    public function search(Request $request, Formatter $formatter)
    {
        $query = $request->get('q');
        $response = $this->productManager->search($query);

        return new JsonResponse($formatter->format($response));
    }

    public function suggest(Request $request, Formatter $formatter)
    {
        $query = $request->get('q');
        $response = $this->productManager->suggest($query);

        return new JsonResponse($formatter->format($response));
    }
}
symfony5 symfony autowired dependency-injection php
1 Answers

As explained here, if you have multiple implementations of the same type of service, you can declare the different types on the configuration, and bind each type to a different parameter name:

services:
    # ...

    # Both these services implement the "Formatter" interface
    App\Util\SearchyFormatter: ~
    App\Util\SuggestyFormatter: ~

    # When you want to use the "SuggestyFormatter" implementation, you
    # type-hint for 'Formatter $suggestyFormatter'
    App\Util\Formatter $suggestyFormatter: '@App\Util\SuggestyFormatter'

    # This is the default implementation for the type
    App\Util\Formatter: '@App\Util\SearchyFormatter'

With this you can do:

// since the parameter name does not match any of the existing declarations,
// the default will be used: App\Util\SearchyFormatter
public function search(Request $request, Formatter $formatter)
{
}

// and for this one, App\Util\SuggestyFormatter will be used instead
public function suggest(Request $request, Formatter $suggestyFormatter)
{
}
user_14265390
Related