phpsymfonydependency-injectionsymfony4service-locator

How do I get a service from the container directly, if I didn't/couldn't inject the service using DI?


I have a part of code where I'm injecting two services $checker and $paginator by dependency injection. It works perfectly:

public function index(Request $request, Paginator $paginator, Checker $checker)
    {
        $result = ['a', 'b', 'c', 'd', 'e', 'f', 'g'];
        $partialResult = $paginator->getPartial($result, 0, 3);
        $checker->isValid('A');
        var_dump("test");
        die;
    }

Below the configuration on services.yaml file:

   paginator:
        public: true
        class: 'App\Helper\Paginator'

    checker:
        public: true
        class: 'App\Helper\Checker'
        arguments:
         $paginator: '@paginator'

But I'd like to inject for some reasons service by method:

$checker = $this->container->get('checker');

But it doesn't work. In previous versions Symfony like 3.4 it used to.

I'm receiving an error:

Service "checker" not found: event though it exists in the app's container, the container inside "App\Controller\DefaultController" is a smaller service locator that only knows about the "http_kernel", "parameter_bag", "request_stack", "router", "session", and "twig" services. Try using dependency injection instead.

How should I solve this?


Solution

  • You need to add your dependencies so the service locator can find them.

    Add a method getSubscribedServices() to your controller class:

    public static function getSubscribedServices()
    {
        return array_merge(
            parent::getSubscribedServices(),
            [
                'checker' => Checker::class,
            ]
        );
    }
    

    If your controller class extends AbstractController you can simply do:

    $this->get('checker');
    

    If you want to do it in another type of class (e.g. a service that doesn't extend AbstractController), then you need to declare that your service implements the ServiceSubscriberInterface.

    use Symfony\Contracts\Service\ServiceSubscriberInterface;
    use Psr\Container\ContainerInterface;
    
    class FooService implements ServiceSubscriberInterface {
    
        public function __construct(ContainerInterface $locator)
        {
            $this->locator = $locator;
        }
    
        public static function getSubscribedServices() { /* same as before */ }
    
        public function get($service)
        {
            return $this->locator->get($service);
        }
    }
    

    ... and you would be able to do the same than you in the controller earlier.