Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.3k
[DependencyInjection] Add section about Service Closures#15730
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,91 @@ | ||||||
| .. index:: | ||||||
| single: DependencyInjection; Service Closures | ||||||
| Service Closures | ||||||
| ================ | ||||||
OskarStark marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||||||
| 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; | ||||||
| use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument; | ||||||
| use Symfony\Component\DependencyInjection\Reference; | ||||||
| return function (ContainerConfigurator $containerConfigurator) { | ||||||
| $services = $containerConfigurator->services(); | ||||||
| $services->set(MyService::class) | ||||||
| ->args([new ServiceClosureArgument(new Reference('mailer'))]); | ||||||
Contributor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Note to mergers: this should be updated to: Suggested change
when merged up in 5.4. MemberAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. There's a separate PR for that#15731 | ||||||
| }; | ||||||
OskarStark marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||||||
| .. seealso:: | ||||||
| Another way to inject services lazily is via a | ||||||
| :doc:`service locators </service_container/service_subscribers_locators>`. | ||||||