layout: documentation
current_menu: symfony

PHP-DI in Symfony

PHP-DI provides an easy and clean integration with Symfony that does not replace the original container:
all bundles and existing code still work the same.

Just to be clear: PHP-DI will work alongside Symfony's container. So you can use both at the same time.

Installation

First install the bridge:

composer require php-di/symfony-bridge

Now you need to make your AppKernel extend DI\Bridge\Symfony\Kernel instead of Symfony's Kernel class:

class AppKernel extends \DI\Bridge\Symfony\Kernel
{
    // ...

    protected function buildPHPDIContainer(ContainerBuilder $builder)
    {
        // Configure your container here
        // https://php-di.org/doc/container-configuration.html
        $builder->addDefinitions(__DIR__ . '/config/config.php');

        return $builder->build();
    }
}

You will need to implement the buildPHPDIContainer() method. That method allows you to configure PHP-DI.

Usage

You can now define controllers as services,
without any configuration, using PHP-DI's power.

Example for the routing configuration:

my_route:
    pattern:  /product-stock/clear
    defaults: { _controller: MyBundle\Controller\ProductController:clearAction }

Careful! Note that you need to use : as a separator, not :: (else it will not go through the container).
The : notation means service_id:method, whereas the :: notation means class::method.

Example with constructor injection:

class ProductController
{
    private $productService;

    public function __construct(ProductService $productService)
    {
        $this->productService = $productService;
    }

    public function clearAction()
    {
        $this->productService->clearStock();
    }
}

Example with property injection:

class ProductController
{
    /**
     * @Inject
     * @var ProductService
     */
    private $productService;

    public function clearAction()
    {
        $this->productService->clearStock();
    }
}

Routing annotations

It is possible to use annotations for routing and still have the controller created by PHP-DI.

You achieve that by specifying the service ID in the @Route annotation (which is most probably the class name itself unless you have a custom setup):

/**
 * @Route(service="My\TestController")
 */
class TestController extends Controller
{
    private $dependency;

    public function __construct(SomeDependency $dependency)
    {
        $this->dependency = $dependency;
    }

    /**
     * @Route("test")
     */
    public function testAction()
    {
        return new Response('ok');
    }
}

Using Symfony's services in PHP-DI

Let's say you want to inject the EntityManager in your controller: the entity manager is defined
in Symfony's container, and the controller is resolved by PHP-DI.

You can reference services that are in Symfony's container in PHP-DI's configuration:

return [
    'AppBundle\Controller\ProductController' => DI\create()
        ->constructor(DI\get('doctrine.orm.entity_manager')),
];

You can also inject PHP-DI services in a Symfony service:

services:
    # app.user_service is a Symfony service
    app.user_service:
        class: 'AppBundle\\Service\\UserService'
        arguments:
            # UserRepository is created by PHP-DI
            - '@AppBundle\\Service\\UserRepository'

Service name aliases

PHP-DI can also work with autowiring or annotations. These rely on the fact that the service name
is the class name (or interface name), e.g. you reference the entity manager by its class name
instead of doctrine.orm.entity_manager.

If you want to enjoy autowiring or annotations, you can simplify your life and write simple aliases
like these:

return [
    'Psr\Log\LoggerInterface' => DI\get('logger'),
    // PHP 5.5 notation:
    ObjectManager::class => DI\get('doctrine.orm.entity_manager'),
];

Keep in mind that it's always better to type-hint against interfaces instead of class names!
So write your aliases with interfaces as much as possible.

FOSRestBundle

There was a bug in FOSRestBundle that would prevent using "Controller as services" in some cases.

This bug has been fixed in FOSRestBundle >=1.3.2. Full details are here: FOSRestBundle#743

More

Read more on the Symfony-Bridge project on GitHub.

layout: documentation

current_menu: symfony