Create Service implementing ContainerAwareInterface - symfony

Question

The service don't invoke setContainer when I extend ContainerAware or implement ContainerAwareInterface.
class CustomService implements ContainerAwareInterface
{
public function setContainer(ContainerInterface $container = null)
{
$this->container = $container;
}
}
How can I use the container from my service without injection one?
Is it required to pass the container object to the constructor or a setter?

Answer 1

Make a definition in your services.yml file
services:
bundle.service_name:
class: ...
calls:
- [ setContainer, [ #service_container ] ]

Answer 2

Only implementing the ContainerAware or ContainerAwareInterface is not enough. You have to call a setter injection with the service_container as argument. But injecting the complete container is not recommended. Better inject only the services you really need.

Answer 3

You have to put the service name inside quotes:
services:
bundle.service_name:
class: ...
calls:
- [ setContainer, [ '#service_container' ]]

Answer 4

There is also ContainerAwareTrait that you can use to implement ContainerAwareInterface.

Answer 5

This is an example of a full implementaion of a container aware service.
But be warned that injecting the whole container should be avoided. It is best practice to inject only the needed components. See the Law of Demeter - Wikipedia for more info on the subject.
To this end, this command will help you find all the available services :
# symfony < 3.0
php app/console debug:container
# symfony >= 3.0
php bin/console debug:container
Anyway, here's the full example.
The app/config/services.yml file:
app.my_service:
class: AppBundle\Service\MyService
calls:
- [setContainer, ['#service_container']]
The service class in src/AppBundle/Service/MyService.php:
<?php
namespace AppBundle\Service;
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerAwareTrait;
class MyService implements ContainerAwareInterface
{
use ContainerAwareTrait;
public function useTheContainer()
{
// do something with the container
$container = $this->container;
}
}
And finaly your controller in src/AppBundle/Controller/MyController.php:
<?php
namespace AppBundle\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Response;
/**
* My controller.
*/
class MyController extends Controller
{
/**
* #Route("/", name="app_index")
* #Method("GET")
*/
public function indexAction(Request $request)
{
$myService = $this->get('app.my_service');
$myService->useTheContainer();
return new Response();
}
}

Answer 6

You might want to automatically call setContainer on all classes that have the ContainerAwareInterface (based on this answer):
# services.yaml
services:
_instanceof:
Symfony\Component\DependencyInjection\ContainerAwareInterface:
calls:
- [setContainer, ['#service_container']]