Skip to content

[DependencyInjection] Invokable Factory Services #11014

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
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
72 changes: 72 additions & 0 deletions service_container/configurators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,78 @@ the service id and the method name:
# old syntax
configurator: ['@App\Mail\EmailConfigurator', configure]

.. _configurators-invokable:

.. versionadded:: 4.3

Invokable configurators for services were introduced in Symfony 4.3.

Services can be configured via invokable configurators (replacing the
``configure()`` method with ``__invoke()``) by omitting the method name, just as
route definitions can reference :ref:`invokable
controllers <controller-service-invoke>`.

.. code-block:: yaml

# app/config/services.yml
services:
# ...

# Registers all 4 classes as services, including AppBundle\Mail\EmailConfigurator
AppBundle\:
resource: '../../src/AppBundle/*'
# ...

# override the services to set the configurator
AppBundle\Mail\NewsletterManager:
configurator: '@AppBundle\Mail\EmailConfigurator'

AppBundle\Mail\GreetingCardManager:
configurator: '@AppBundle\Mail\EmailConfigurator'

.. code-block:: xml

<!-- app/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
http://symfony.com/schema/dic/services/services-1.0.xsd">

<services>
<prototype namespace="AppBundle\" resource="../../src/AppBundle/*" />

<service id="AppBundle\Mail\NewsletterManager">
<configurator service="AppBundle\Mail\EmailConfigurator" />
</service>

<service id="AppBundle\Mail\GreetingCardManager">
<configurator service="AppBundle\Mail\EmailConfigurator" />
</service>
</services>
</container>

.. code-block:: php

// app/config/services.php
use AppBundle\Mail\GreetingCardManager;
use AppBundle\Mail\NewsletterManager;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Reference;

// Same as before
$definition = new Definition();

$definition->setAutowired(true);

$this->registerClasses($definition, 'AppBundle\\', '../../src/AppBundle/*');

$container->getDefinition(NewsletterManager::class)
->setConfigurator(new Reference(EmailConfigurator::class));

$container->getDefinition(GreetingCardManager::class)
->setConfigurator(new Reference(EmailConfigurator::class));

That's it! When requesting the ``App\Mail\NewsletterManager`` or
``App\Mail\GreetingCardManager`` service, the created instance will first be
passed to the ``EmailConfigurator::configure()`` method.
70 changes: 70 additions & 0 deletions service_container/factories.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,76 @@ Configuration of the service container then looks like this:
# old syntax
factory: ['@App\Email\NewsletterManagerFactory', createNewsletterManager]

.. _factories-invokable:

Suppose you now change your factory method to ``__invoke()`` so that your
factory service can be used as a callback::

class InvokableNewsletterManagerFactory
{
public function __invoke()
{
$newsletterManager = new NewsletterManager();

// ...

return $newsletterManager;
}
}

.. versionadded:: 4.3

Invokable factories for services were introduced in Symfony 4.3.

Services can be created and configured via invokable factories by omitting the
method name, just as route definitions can reference :ref:`invokable
controllers <controller-service-invoke>`.

.. configuration-block::

.. code-block:: yaml

# app/config/services.yml

services:
# ...

AppBundle\Email\NewsletterManager:
class: AppBundle\Email\NewsletterManager
factory: '@AppBundle\Email\NewsletterManagerFactory'

.. code-block:: xml

<!-- app/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
http://symfony.com/schema/dic/services/services-1.0.xsd">

<services>
<!-- ... -->

<service id="AppBundle\Email\NewsletterManager"
class="AppBundle\Email\NewsletterManager">
<factory service="AppBundle\Email\NewsletterManagerFactory" />
</service>
</services>
</container>

.. code-block:: php

// app/config/services.php

use AppBundle\Email\NewsletterManager;
use AppBundle\Email\NewsletterManagerFactory;
use Symfony\Component\DependencyInjection\Reference;

// ...
$container->register(NewsletterManager::class, NewsletterManager::class)
->setFactory(new Reference(NewsletterManagerFactory::class));

.. _factories-passing-arguments-factory-method:

Passing Arguments to the Factory Method
Expand Down