Skip to content

[DependencyInjection] Add section about Service Closures #15731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion service_container/lazy_services.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Lazy Services

.. seealso::

Another way to inject services lazily is via a :doc:`service subscriber </service_container/service_subscribers_locators>`.
Other ways to inject services lazily are via a :doc:`service closure </service_container/service_closures>` or
:doc:`service subscriber </service_container/service_subscribers_locators>`.

Why Lazy Services?
------------------
Expand Down
115 changes: 115 additions & 0 deletions service_container/service_closures.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
.. index::
single: DependencyInjection; Service Closures

Service Closures
================

.. versionadded:: 5.4

The ``service_closure()`` function was introduced in Symfony 5.4.

This feature wraps the injected service into a closure allowing it to be
lazily loaded when and if needed.
This is useful if the service being injected is a bit heavy to instantiate
or is used only in certain cases.
The service is instantiated the first time the closure is called, while
all subsequent calls return the same instance, unless the service is
:doc:`not shared </service_container/shared>`::

// src/Service/MyService.php
namespace App\Service;

use Symfony\Component\Mailer\MailerInterface;

class MyService
{
/**
* @var callable(): MailerInterface
*/
private \Closure $mailer;

public function __construct(\Closure $mailer)
{
$this->mailer = $mailer;
}

public function doSomething(): void
{
// ...

$this->getMailer()->send($email);
}

private function getMailer(): MailerInterface
{
return ($this->mailer)();
}
}

To define a service closure and inject it to another service, create an
argument of type ``service_closure``:

.. configuration-block::

.. code-block:: yaml

# config/services.yaml
services:
App\Service\MyService:
arguments: [!service_closure '@mailer']

.. code-block:: xml

<!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd">

<services>
<service id="App\Service\MyService">
<argument type="service_closure" id="mailer"/>
</service>
</services>
</container>

.. code-block:: php

// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use App\Service\MyService;

return function (ContainerConfigurator $containerConfigurator) {
$services = $containerConfigurator->services();

$services->set(MyService::class)
->args([service_closure('mailer')]);

// In case the dependency is optional
// $services->set(MyService::class)
// ->args([service_closure('mailer')->ignoreOnInvalid()]);
};

.. seealso::

Another way to inject services lazily is via a
:doc:`service locator </service_container/service_subscribers_locators>`.

Using a Service Closure in a Compiler Pass
------------------------------------------

In :doc:`compiler passes </service_container/compiler_passes>` you can create
a service closure by wrapping the service reference into an instance of
:class:`Symfony\\Component\\DependencyInjection\\Argument\\ServiceClosureArgument`::

use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Reference;

public function process(ContainerBuilder $containerBuilder): void
{
// ...

$myService->addArgument(new ServiceClosureArgument(new Reference('mailer')));
}
5 changes: 5 additions & 0 deletions service_container/service_subscribers_locators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ instantiation of the services to be lazy. However, that's not possible using
the explicit dependency injection since services are not all meant to
be ``lazy`` (see :doc:`/service_container/lazy_services`).

.. seealso::

Another way to inject services lazily is via a
:doc:`service closure </service_container/service_closures>`.

This can typically be the case in your controllers, where you may inject several
services in the constructor, but the action called only uses some of them.
Another example are applications that implement the `Command pattern`_
Expand Down