Rework more controllers

Author: GuilhemN

form/form_dependencies.rst

@@ -8,9 +8,9 @@ configuration from inside of your form class. To do this, you have 2 options:
 ----------------------------
 
 The simplest way to pass services or configuration to your form is via form *options*.
-Suppose you need to access the ``doctrine.orm.entity_manager`` service so that you
-can make a query. First, allow (in fact, require) a new ``entity_manager`` option
-to be passed to your form::
+Suppose you need to access the Doctrine entity manager so that you can make a
+query. First, allow (in fact, require) a new ``entity_manager`` option to be
+passed to your form::
 
     // src/AppBundle/Form/TaskType.php
     // ...
@@ -32,13 +32,17 @@ create your form::
 
     // src/AppBundle/Controller/DefaultController.php
     use AppBundle\Form\TaskType;
+    use Doctrine\ORM\EntityManagerInterface;
 
     // ...
-    public function newAction()
+    public function newAction(EntityManagerInterface $em)
     {
+        // or fetch the em via the container
+        // $em = $this->get('doctrine')->getManager();
+
         $task = ...;
         $form = $this->createForm(TaskType::class, $task, array(
-            'entity_manager' => $this->get('doctrine.orm.entity_manager')
+            'entity_manager' => $em,
         ));
 
         // ...

service_container/autowiring.rst

@@ -15,7 +15,7 @@ with `ROT13`_ (a special case of the Caesar cipher).
 
 Start by creating a ROT13 transformer class::
 
-    namespace Acme;
+    namespace AppBundle;
 
     class Rot13Transformer
     {
@@ -27,7 +27,7 @@ Start by creating a ROT13 transformer class::
 
 And now a Twitter client using this transformer::
 
-    namespace Acme;
+    namespace AppBundle;
 
     class TwitterClient
     {
@@ -47,16 +47,15 @@ And now a Twitter client using this transformer::
     }
 
 The DependencyInjection component will be able to automatically register
-the dependencies of this ``TwitterClient`` class when the ``twitter_client``
-service is marked as autowired:
+the dependencies of this ``TwitterClient`` class when its service is marked as
+autowired:
 
 .. configuration-block::
 
     .. code-block:: yaml
 
         services:
-            twitter_client:
-                class:    Acme\TwitterClient
+            AppBundle\TwitterClient:
                 autowire: true
 
     .. code-block:: xml
@@ -67,17 +66,17 @@ service is marked as autowired:
             xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
             <services>
-                <service id="twitter_client" class="Acme\TwitterClient" autowire="true" />
+                <service id="AppBundle\TwitterClient" autowire="true" />
             </services>
         </container>
 
     .. code-block:: php
 
-        use Acme\TwitterClient;
+        use AppBundle\TwitterClient;
 
         // ...
 
-        $container->autowire('twitter_client', TwitterClient::class);
+        $container->autowire(TwitterClient::class);
 
 
 .. versionadded:: 3.3
@@ -101,10 +100,11 @@ to change the dependencies of the ``TwitterClient`` class: just add or remove ty
 arguments in the constructor and you are done. There is no need anymore to search
 and edit related service definitions.
 
-Here is a typical controller using the ``twitter_client`` service::
+Here is a typical controller using the ``TwitterClient``::
 
-    namespace Acme\Controller;
+    namespace AppBundle\Controller;
 
+    use AppBundle\TwitterClient;
     use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
     use Symfony\Bundle\FrameworkBundle\Controller\Controller;
@@ -118,7 +118,7 @@ Here is a typical controller using the ``twitter_client`` service::
          * @Route("/tweet")
          * @Method("POST")
          */
-        public function tweetAction(Request $request)
+        public function tweetAction(Request $request, TwitterClient $twitterClient)
         {
             $user = $request->request->get('user');
             $key = $request->request->get('key');
@@ -128,7 +128,10 @@ Here is a typical controller using the ``twitter_client`` service::
                 throw new BadRequestHttpException();
             }
 
-            $this->get('twitter_client')->tweet($user, $key, $status);
+            $twitterClient->tweet($user, $key, $status);
+
+            // or using the container
+            // $this->container->get(TwitterClient::class)->tweet($user, $key, $status);
 
             return new Response('OK');
         }
@@ -154,7 +157,7 @@ and not concrete classes. It allows to replace easily the current implementation
 if necessary. It also allows to use other transformers. You can create a
 ``TransformerInterface`` containing just one method (``transform()``)::
 
-    namespace Acme;
+    namespace AppBundle;
 
     interface TransformerInterface
     {
@@ -189,11 +192,9 @@ subsystem isn't able to find itself the interface implementation to register:
     .. code-block:: yaml
 
         services:
-            rot13_transformer:
-                class: Acme\Rot13Transformer
+            AppBundle\Rot13Transformer: ~
 
-            twitter_client:
-                class:    Acme\TwitterClient
+            AppBundle\TwitterClient:
                 autowire: true
 
     .. code-block:: xml
@@ -204,24 +205,25 @@ subsystem isn't able to find itself the interface implementation to register:
             xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
             <services>
-                <service id="rot13_transformer" class="Acme\Rot13Transformer" />
+                <service id="AppBundle\Rot13Transformer" />
 
-                <service id="twitter_client" class="Acme\TwitterClient" autowire="true" />
+                <service id="AppBundle\TwitterClient" autowire="true" />
             </services>
         </container>
 
     .. code-block:: php
 
-        use Acme\TwitterClient;
+        use AppBundle\Rot13Transformer;
+        use AppBundle\TwitterClient;
 
         // ...
-        $container->register('rot13_transformer', 'Acme\Rot13Transformer');
-        $container->autowire('twitter_client', TwitterClient::class);
+        $container->register(Rot13Transformer::class);
+        $container->autowire(TwitterClient::class);
 
-The autowiring subsystem detects that the ``rot13_transformer`` service implements
-the ``TransformerInterface`` and injects it automatically. Even when using
-interfaces (and you should), building the service graph and refactoring the project
-is easier than with standard definitions.
+The autowiring subsystem detects that the ``AppBundle\Rot13Transformer`` service
+implements the ``TransformerInterface`` and injects it automatically. Even when
+using interfaces (and you should), building the service graph and refactoring
+the project is easier than with standard definitions.
 
 .. _service-autowiring-alias:
 
@@ -232,7 +234,7 @@ Last but not least, the autowiring feature allows to specify the default impleme
 of a given type. Let's introduce a new implementation of the ``TransformerInterface``
 returning the result of the ROT13 transformation uppercased::
 
-    namespace Acme;
+    namespace AppBundle;
 
     class UppercaseTransformer implements TransformerInterface
     {
@@ -254,8 +256,9 @@ This class is intended to decorate any transformer and return its value uppercas
 The controller can now be refactored to add a new endpoint using this uppercase
 transformer::
 
-    namespace Acme\Controller;
+    namespace AppBundle\Controller;
 
+    use AppBundle\TwitterClient;
     use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
     use Symfony\Bundle\FrameworkBundle\Controller\Controller;
@@ -269,9 +272,9 @@ transformer::
          * @Route("/tweet")
          * @Method("POST")
          */
-        public function tweetAction(Request $request)
+        public function tweetAction(Request $request, TwitterClient $twitterClient)
         {
-            return $this->tweet($request, 'twitter_client');
+            return $this->tweet($request, $twitterClient);
         }
 
         /**
@@ -280,10 +283,13 @@ transformer::
          */
         public function tweetUppercaseAction(Request $request)
         {
-            return $this->tweet($request, 'uppercase_twitter_client');
+            // not the default implementation
+            $twitterClient = $this->get('uppercase_twitter_client');
+
+            return $this->tweet($request, $twitterClient);
         }
 
-        private function tweet(Request $request, $service)
+        private function tweet(Request $request, TwitterClient $twitterClient)
         {
             $user = $request->request->get('user');
             $key = $request->request->get('key');
@@ -293,7 +299,7 @@ transformer::
                 throw new BadRequestHttpException();
             }
 
-            $this->get($service)->tweet($user, $key, $status);
+            $twitterClient->tweet($user, $key, $status);
 
             return new Response('OK');
         }
@@ -307,22 +313,19 @@ and a Twitter client using it:
     .. code-block:: yaml
 
         services:
-            rot13_transformer:
-                class: Acme\Rot13Transformer
+            AppBundle\Rot13Transformer: ~
 
-            Acme\TransformerInterface: '@rot13_transformer'
+            AppBundle\TransformerInterface: '@AppBundle\Rot13Transformer'
 
-            twitter_client:
-                class:    Acme\TwitterClient
+            AppBundle\TwitterClient:
                 autowire: true
 
-            uppercase_transformer:
-                class:    Acme\UppercaseTransformer
+            AppBundle\UppercaseTransformer:
                 autowire: true
 
             uppercase_twitter_client:
-                class:     Acme\TwitterClient
-                arguments: ['@uppercase_transformer']
+                class:     AppBundle\TwitterClient
+                arguments: ['@AppBundle\UppercaseTransformer']
 
     .. code-block:: xml
 
@@ -332,38 +335,36 @@ and a Twitter client using it:
             xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
             <services>
-                <service id="rot13_transformer" class="Acme\Rot13Transformer" />
+                <service id="AppBundle\Rot13Transformer" />
 
-                <service id="Acme\TransformerInterface" alias="rot13_transformer" />
+                <service id="AppBundle\TransformerInterface" alias="AppBundle\Rot13Transformer" />
 
-                <service id="twitter_client" class="Acme\TwitterClient" autowire="true" />
+                <service id="AppBundle\TwitterClient" autowire="true" />
 
-                <service id="uppercase_transformer" class="Acme\UppercaseTransformer"
-                    autowire="true"
-                />
+                <service id="AppBundle\UppercaseTransformer" autowire="true" />
 
-                <service id="uppercase_twitter_client" class="Acme\TwitterClient">
-                    <argument type="service" id="uppercase_transformer" />
+                <service id="uppercase_twitter_client" class="AppBundle\TwitterClient">
+                    <argument type="service" id="AppBundle\UppercaseTransformer" />
                 </service>
             </services>
         </container>
 
     .. code-block:: php
 
-        use Acme\Rot13Transformer;
-        use Acme\TransformerInterface;
-        use Acme\TwitterClient;
-        use Acme\UppercaseTransformer;
+        use AppBundle\Rot13Transformer;
+        use AppBundle\TransformerInterface;
+        use AppBundle\TwitterClient;
+        use AppBundle\UppercaseTransformer;
         use Symfony\Component\DependencyInjection\Reference;
 
         // ...
-        $container->register('rot13_transformer', Rot13Transformer::class);
-        $container->setAlias(TransformerInterface::class, 'rot13_transformer')
+        $container->register(Rot13Transformer::class);
+        $container->setAlias(TransformerInterface::class, Rot13Transformer::class)
 
-        $container->autowire('twitter_client', TwitterClient::class);
-        $container->autowire('uppercase_transformer', UppercaseTransformer::class);
+        $container->autowire(TwitterClient::class);
+        $container->autowire(UppercaseTransformer::class);
         $container->register('uppercase_twitter_client', TwitterClient::class)
-            ->addArgument(new Reference('uppercase_transformer'));
+            ->addArgument(new Reference(UppercaseTransformer::class));
 
 This deserves some explanations. You now have two services implementing the
 ``TransformerInterface``. The autowiring subsystem cannot guess which one
@@ -372,19 +373,20 @@ to use which leads to errors like this:
 .. code-block:: text
 
       [Symfony\Component\DependencyInjection\Exception\RuntimeException]
-      Unable to autowire argument of type "Acme\TransformerInterface" for the service "twitter_client".
+      Unable to autowire argument of type "AppBundle\TransformerInterface" for the service "AppBundle\TwitterClient".
 
-Fortunately, the FQCN alias is here to specify which implementation
-to use by default.
+Fortunately, the FQCN alias (the ``AppBundle\TransformerInterface`` alias) is
+here to specify which implementation to use by default.
 
 .. versionadded:: 3.3
     Using FQCN aliases to fix autowiring ambiguities is allowed since Symfony
     3.3. Prior to version 3.3, you needed to use the ``autowiring_types`` key.
 
-Thanks to this alias, the ``rot13_transformer`` service is automatically injected
-as an argument of the ``uppercase_transformer`` and ``twitter_client`` services. For
-the ``uppercase_twitter_client``, a standard service definition is used to
-inject the specific ``uppercase_transformer`` service.
+Thanks to this alias, the ``AppBundle\Rot13Transformer`` service is
+automatically injected as an argument of the ``AppBundle\UppercaseTransformer``
+and ``AppBundle\TwitterClient`` services. For the ``uppercase_twitter_client``,
+a standard service definition is used to inject the specific
+``AppBundle\UppercaseTransformer`` service.
 
 As for other RAD features such as the FrameworkBundle controller or annotations,
 keep in mind to not use autowiring in public bundles nor in large projects with