Skip to content

Document ContainerBuilder::autowire() #7858

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.

Sign up for GitHub

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
May 2, 2017
Merged

Document ContainerBuilder::autowire() #7858

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 12 additions & 22 deletions service_container/autowiring.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,16 @@ service is marked as autowired:
.. code-block:: php

use Acme\TwitterClient;
use Symfony\Component\DependencyInjection\Definition;

// ...
$definition = new Definition(TwitterClient::class);
$definition->setAutowired(true);

$container->setDefinition('twitter_client', $definition);
$container->autowire('twitter_client', TwitterClient::class);


.. versionadded:: 3.3
The method ``ContainerBuilder::autowire()`` was introduced in Symfony 3.3.
Prior to version 3.3, you needed to use the ``Definition::setAutowired()``
method.

The autowiring subsystem will detect the dependencies of the ``TwitterClient``
class by parsing its constructor. For instance it will find here an instance of
Expand Down Expand Up @@ -210,14 +213,10 @@ subsystem isn't able to find itself the interface implementation to register:
.. code-block:: php

use Acme\TwitterClient;
use Symfony\Component\DependencyInjection\Definition;

// ...
$container->register('rot13_transformer', 'Acme\Rot13Transformer');

$clientDefinition = new Definition(TwitterClient::class);
$clientDefinition->setAutowired(true);
$container->setDefinition('twitter_client', $clientDefinition);
$container->autowire('twitter_client', TwitterClient::class);

The autowiring subsystem detects that the ``rot13_transformer`` service implements
the ``TransformerInterface`` and injects it automatically. Even when using
Expand Down Expand Up @@ -354,24 +353,15 @@ and a Twitter client using it:
use Acme\TwitterClient;
use Acme\UppercaseTransformer;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\DependencyInjection\Definition;

// ...
$container->register('rot13_transformer', Rot13Transformer::class);
$container->setAlias(TransformerInterface::class, 'rot13_transformer')

$clientDefinition = new Definition(TwitterClient::class);
$clientDefinition->setAutowired(true);
$container->setDefinition('twitter_client', $clientDefinition);

$uppercaseDefinition = new Definition(UppercaseTransformer::class);
$uppercaseDefinition->setAutowired(true);
$container->setDefinition('uppercase_transformer', $uppercaseDefinition);

$uppercaseClientDefinition = new Definition(TwitterClient::class, array(
new Reference('uppercase_transformer'),
));
$container->setDefinition('uppercase_twitter_client', $uppercaseClientDefinition);
$container->autowire('twitter_client', TwitterClient::class);
$container->autowire('uppercase_transformer', UppercaseTransformer::class);
$container->register('uppercase_twitter_client', TwitterClient::class)
->addArgument(new Reference('uppercase_transformer'));

This deserves some explanations. You now have two services implementing the
``TransformerInterface``. The autowiring subsystem cannot guess which one
Expand Down