Adding details and usages of fetching the service as a controller arg

weaverryan · weaverryan · commit 45500b3398dd · 2017-05-02T05:52:28.000-04:00
diff --git a/controller.rst b/controller.rst
@@ -159,6 +159,11 @@ controller classes. A great way to see the core functionality in
 action is to look in the
 :class:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller` class.
 
+.. tip::
+    If you know what you're doing, you can alternatively extend
+    :class:`Symfony\\Bundle\\FrameworkBundle\\Controller\\AbstractController`. It
+    has all the same shortcuts, but does not have a ```$this->container`` property.
+
 .. index::
    single: Controller; Redirecting
 
@@ -247,10 +252,9 @@ The Symfony templating system and Twig are explained more in the
 Accessing other Services
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-Symfony comes packed with a lot of useful objects, called *services*. These
-are used for rendering templates, sending emails, querying the database and
-any other "work" you can think of. When you install a new bundle, it probably
-brings in even *more* services.
+Symfony comes packed with a lot of useful objects, called :doc:`services </service_container>`.
+These are used for rendering templates, sending emails, querying the database and
+any other "work" you can think of.
 
 When extending the base ``Controller`` class, you can access any Symfony service
 via the :method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::get`
@@ -262,6 +266,9 @@ method. Here are several common services you might need::
 
     $mailer = $this->get('mailer');
 
+    // you can also fetch parameters
+    $someParameter = $this->getParameter('some_parameter');
+
 What other services exist? To list all services, use the ``debug:container``
 console command:
 
@@ -271,14 +278,31 @@ console command:
 
 For more information, see the :doc:`/service_container` article.
 
-.. tip::
+Services as Controller Arguments
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can also tell Symfony to pass your a service as a controller argument by type-hinting
+it::
 
-    To get a :ref:`container configuration parameter <config-parameter-intro>`,
-    use the
-    :method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::getParameter`
-    method::
+    use Psr\Log\LoggerInterface
+    // ...
+
+    /**
+     * @Route("/lucky/number/{max}")
+     */
+    public function numberAction($max, LoggerInterface $logger)
+    {
+        $logger->info('We are logging!');
 
-        $from = $this->getParameter('app.mailer.from');
+        // ...
+    }
+
+.. note::
+    If this isn't working, make sure your controller is registered as a service,
+    :ref:`autoconfigured <services-autoconfigure>` and extends either
+    :class:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller` or
+    :class:`Symfony\\Bundle\\FrameworkBundle\\Controller\\AbstractController`. Or,
+    you can tag it manually with ``controller.service_arguments``.
 
 .. index::
    single: Controller; Managing errors
@@ -418,20 +442,6 @@ For example, imagine you're processing a :doc:`form </forms>` submission::
         return $this->render(...);
     }
 
-.. tip::
-
-    As a developer, you might prefer not to extend the ``Controller``. To
-    use the flash message functionality, you can request the flash bag from
-    the :class:`Symfony\\Component\\HttpFoundation\\Session\\Session`::
-
-        use Symfony\Component\HttpFoundation\Session\Session;
-
-        public function indexAction(Session $session)
-        {
-            // getFlashBag is not available in the SessionInterface and requires the Session
-            $flashBag = $session->getFlashBag();
-        }
-
 After processing the request, the controller sets a flash message in the session
 and then redirects. The message key (``notice`` in this example) can be anything:
 you'll use this key to retrieve the message.
diff --git a/doctrine.rst b/doctrine.rst
@@ -548,6 +548,7 @@ a controller, this is pretty easy. Add the following method to the
     // ...
     use AppBundle\Entity\Product;
     use Symfony\Component\HttpFoundation\Response;
+    use Doctrine\ORM\EntityManagerInterface;
 
     // ...
     public function createAction()
@@ -568,6 +569,12 @@ a controller, this is pretty easy. Add the following method to the
         return new Response('Saved new product with id '.$product->getId());
     }
 
+    // you can also receive the $em as an argument
+    public function editAction(EntityManagerInterface $em)
+    {
+        // ...
+    }
+
 .. note::
 
     If you're following along with this example, you'll need to create a
diff --git a/email.rst b/email.rst
@@ -100,7 +100,7 @@ The Swift Mailer library works by creating, configuring and then sending
 of the message and is accessible via the ``mailer`` service. Overall, sending
 an email is pretty straightforward::
 
-    public function indexAction($name)
+    public function indexAction($name, \Swift_Mailer $mailer)
     {
         $message = \Swift_Message::newInstance()
             ->setSubject('Hello Email')
@@ -125,7 +125,11 @@ an email is pretty straightforward::
             )
             */
         ;
-        $this->get('mailer')->send($message);
+
+        $mailer->send($message);
+
+        // or, you can also fetch the mailer service in this way
+        // $this->get('mailer')->send($message);
 
         return $this->render(...);
     }
diff --git a/logging.rst b/logging.rst
@@ -10,9 +10,13 @@ Logging a Message
 To log a message, fetch the ``logger`` service from the container in
 your controller::
 
-    public function indexAction()
+    use Psr\Log\LoggerInterface;
+
+    public function indexAction(LoggerInterface $logger)
     {
-        $logger = $this->get('logger');
+        // alternative way of getting the logger
+        // $logger = $this->get('logger');
+
         $logger->info('I just got the logger');
         $logger->error('An error occurred');
         
diff --git a/service_container.rst b/service_container.rst
@@ -511,6 +511,8 @@ service whose id is ``monolog.logger.request``.
     the *service* whose id is ``monolog.logger.request``, and not just the *string*
     ``monolog.logger.request``.
 
+.. _services-autoconfigure:
+
 The autoconfigure Option
 ------------------------
 

Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ The Swift Mailer library works by creating, configuring and then sending`
`100`	`100`	of the message and is accessible via the ``mailer`` service. Overall, sending
`101`	`101`	`an email is pretty straightforward::`
`102`	`102`
`103`		`- public function indexAction($name)`
	`103`	`+ public function indexAction($name, \Swift_Mailer $mailer)`
`104`	`104`	`{`
`105`	`105`	`$message = \Swift_Message::newInstance()`
`106`	`106`	`->setSubject('Hello Email')`
`@@ -125,7 +125,11 @@ an email is pretty straightforward::`
`125`	`125`	`)`
`126`	`126`	`*/`
`127`	`127`	`;`
`128`		`- $this->get('mailer')->send($message);`
	`128`	`+`
	`129`	`+ $mailer->send($message);`
	`130`	`+`
	`131`	`+ // or, you can also fetch the mailer service in this way`
	`132`	`+ // $this->get('mailer')->send($message);`
`129`	`133`
`130`	`134`	`return $this->render(...);`
`131`	`135`	`}`