-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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)(); | ||
OskarStark marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
} | ||
|
||
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 | ||
OskarStark marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// $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'))); | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.