feature #5046 Rebased "add shortcut methods" (Cydonia7, WouterJ)

weaverryan · weaverryan · commit 3405c42180a5 · 2015-03-14T14:28:33.000-04:00
This PR was merged into the 2.6 branch. Discussion ---------- Rebased "add shortcut methods" Replaces #4109 Original Pr description: > | Q | A > | ------------- | --- > | Doc fix? | no > | New docs? | yes (symfony/symfony#11593) > | Applies to | 2.6+ > | Fixed tickets | #4666 > > This commit is associated to symfony/symfony#11593 that adds new shortcut methods to controllers. > > If anything is wrong with my commit or this description, please tell me and I will fix it as soon as possible. I'm glad I finally try to help this awesome project. Commits ------- 994ed3a Little fixes f807d14 Fixes 5b015f2 Modifications according to comments 7f9bc8c And now the same for isGranted where it is possible 46e2505 Changed to addFlash where it is possible (ie in controllers) 643c458 redirect changed to redirectToRoute 7ae62e8 Minor improvements 4611ce9 Minor format improvements 3bcb186 Added shortcut methods for controllers
diff --git a/book/controller.rst b/book/controller.rst
@@ -429,35 +429,47 @@ A great way to see the core functionality in action is to look in the
 Redirecting
 ~~~~~~~~~~~
 
-If you want to redirect the user to another page, use the
-:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::redirect`
-method::
+If you want to redirect the user to another page, use the ``redirectToRoute()`` method::
 
     public function indexAction()
     {
-        return $this->redirect($this->generateUrl('homepage'));
+        return $this->redirectToRoute('homepage');
+
+        // redirectToRoute is equivalent to using redirect() and generateUrl() together:
+        // return $this->redirect($this->generateUrl('homepage'), 301);
     }
 
-The ``generateUrl()`` method is just a helper function that generates the URL
-for a given route. For more information, see the :doc:`Routing </book/routing>`
-chapter.
+.. versionadded:: 2.6
+    The ``redirectToRoute()`` method was added in Symfony 2.6. Previously (and still now), you
+    could use ``redirect()`` and ``generateUrl()`` together for this (see the example above).
+
+Or, if you want to redirect externally, just use ``redirect()`` and pass it the URL::
+
+    public function indexAction()
+    {
+        return $this->redirect('http://symfony.com/doc');
+    }
 
-By default, the ``redirect()`` method performs a 302 (temporary) redirect. To
+By default, the ``redirectToRoute()`` method performs a 302 (temporary) redirect. To
 perform a 301 (permanent) redirect, modify the second argument::
 
     public function indexAction()
     {
-        return $this->redirect($this->generateUrl('homepage'), 301);
+        return $this->redirectToRoute('homepage', array(), 301);
     }
 
 .. tip::
 
-    The ``redirect()`` method is simply a shortcut that creates a ``Response``
-    object that specializes in redirecting the user. It's equivalent to::
+    The ``redirectToRoute()`` method is simply a shortcut that creates a
+    ``Response`` object that specializes in redirecting the user. It's
+    equivalent to::
 
         use Symfony\Component\HttpFoundation\RedirectResponse;
 
-        return new RedirectResponse($this->generateUrl('homepage'));
+        public function indexAction()
+        {
+            return new RedirectResponse($this->generateUrl('homepage'));
+        }
 
 .. index::
    single: Controller; Rendering templates
@@ -623,12 +635,14 @@ For example, imagine you're processing a form submit::
         if ($form->isValid()) {
             // do some sort of processing
 
-            $request->getSession()->getFlashBag()->add(
+            $this->addFlash(
                 'notice',
                 'Your changes were saved!'
             );
 
-            return $this->redirect($this->generateUrl(...));
+            // $this->addFlash is equivalent to $this->get('session')->getFlashBag()->add
+
+            return $this->redirectToRoute(...);
         }
 
         return $this->render(...);
@@ -638,8 +652,8 @@ After processing the request, the controller sets a ``notice`` flash message
 in the session and then redirects. The name (``notice``) isn't significant -
 it's just something you invent and reference next.
 
-In the template of the next page (or even better, in your base layout template),
-the following code will render the ``notice`` message:
+In the template of the next action, the following code could be used to render
+the ``notice`` message:
 
 .. configuration-block::
 
diff --git a/book/doctrine.rst b/book/doctrine.rst
@@ -667,7 +667,7 @@ you have a route that maps a product id to an update action in a controller::
         $product->setName('New product name!');
         $em->flush();
 
-        return $this->redirect($this->generateUrl('homepage'));
+        return $this->redirectToRoute('homepage');
     }
 
 Updating an object involves just three steps:
diff --git a/book/forms.rst b/book/forms.rst
@@ -234,7 +234,7 @@ controller::
         if ($form->isValid()) {
             // perform some action, such as saving the task to the database
 
-            return $this->redirect($this->generateUrl('task_success'));
+            return $this->redirectToRoute('task_success');
         }
 
         // ...
@@ -319,7 +319,7 @@ querying if the "Save and add" button was clicked::
             ? 'task_new'
             : 'task_success';
 
-        return $this->redirect($this->generateUrl($nextAction));
+        return $this->redirectToRoute($nextAction);
     }
 
 .. index::
@@ -1233,7 +1233,7 @@ it after a form submission can be done when the form is valid::
         $em->persist($task);
         $em->flush();
 
-        return $this->redirect($this->generateUrl('task_success'));
+        return $this->redirectToRoute('task_success');
     }
 
 If, for some reason, you don't have access to your original ``$task`` object,
diff --git a/book/propel.rst b/book/propel.rst
@@ -241,11 +241,15 @@ have a route that maps a product id to an update action in a controller::
                 );
             }
 
+<<<<<<< HEAD
             $product->setName('New product name!');
             $product->save();
 
             return $this->redirect($this->generateUrl('homepage'));
         }
+=======
+        return $this->redirectToRoute('homepage');
+>>>>>>> pull/5046
     }
 
 Updating an object involves just three steps:
diff --git a/book/security.rst b/book/security.rst
@@ -813,23 +813,25 @@ You can easily deny access from inside a controller::
 
     public function helloAction($name)
     {
-        if (false === $this->get('security.authorization_checker')->isGranted('ROLE_ADMIN')) {
-            throw $this->createAccessDeniedException();
-        }
+        // The second parameter is used to specify on what object the role is tested.
+        $this->denyAccessUnlessGranted('ROLE_ADMIN', null, 'Unable to access this page!');
+
+        // Old way :
+        // if (false === $this->get('security.context')->isGranted('ROLE_ADMIN')) {
+        //     throw $this->createAccessDeniedException('Unable to access this page!');
+        // }
 
         // ...
     }
 
 .. versionadded:: 2.6
-     The ``security.authorization_checker`` service was introduced in Symfony 2.6. Prior
-     to Symfony 2.6, you had to use the ``isGranted()`` method of the ``security.context`` service.
-
-.. versionadded:: 2.5
-    The ``createAccessDeniedException`` method was introduced in Symfony 2.5.
+    The ``denyAccessUnlessGranted()`` method was introduced in Symfony 2.6. Previously (and
+    still now), you could check access directly and throw the ``AccessDeniedException`` as shown
+    in the example above).
 
-The :method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::createAccessDeniedException`
-method creates a special :class:`Symfony\\Component\\Security\\Core\\Exception\\AccessDeniedException`
-object, which ultimately triggers a 403 HTTP response inside Symfony.
+In both cases, a special
+:class:`Symfony\\Component\\Security\\Core\\Exception\\AccessDeniedException`
+is thrown, which ultimately triggers a 403 HTTP response inside Symfony.
 
 That's it! If the user isn't logged in yet, they will be asked to login (e.g.
 redirected to the login page). If they *are* logged in, they'll be shown
diff --git a/book/validation.rst b/book/validation.rst
@@ -232,7 +232,7 @@ workflow looks like the following from inside a controller::
         if ($form->isValid()) {
             // the validation passed, do something with the $author object
 
-            return $this->redirect($this->generateUrl(...));
+            return $this->redirectToRoute(...);
         }
 
         return $this->render('author/form.html.twig', array(
diff --git a/components/form/introduction.rst b/components/form/introduction.rst
@@ -587,7 +587,7 @@ method:
 
                 // ... perform some action, such as saving the data to the database
 
-                return $this->redirect($this->generateUrl('task_success'));
+                return $this->redirectToRoute('task_success');
             }
 
             // ...
diff --git a/cookbook/doctrine/file_uploads.rst b/cookbook/doctrine/file_uploads.rst
@@ -244,7 +244,7 @@ The following controller shows you how to handle the entire process::
             $em->persist($document);
             $em->flush();
 
-            return $this->redirect($this->generateUrl(...));
+            return $this->redirectToRoute(...);
         }
 
         return array('form' => $form->createView());
@@ -267,7 +267,7 @@ in a moment to handle the file upload::
         $em->persist($document);
         $em->flush();
 
-        return $this->redirect(...);
+        return $this->redirectToRoute(...);
     }
 
 The ``upload()`` method will take advantage of the :class:`Symfony\\Component\\HttpFoundation\\File\\UploadedFile`
@@ -432,7 +432,7 @@ call to ``$document->upload()`` should be removed from the controller::
         $em->persist($document);
         $em->flush();
 
-        return $this->redirect(...);
+        return $this->redirectToRoute(...);
     }
 
 .. note::
diff --git a/cookbook/doctrine/registration_form.rst b/cookbook/doctrine/registration_form.rst
@@ -287,7 +287,7 @@ the validation and saves the data into the database::
             $em->persist($registration->getUser());
             $em->flush();
 
-            return $this->redirect(...);
+            return $this->redirectToRoute(...);
         }
 
         return $this->render(
diff --git a/cookbook/expression/expressions.rst b/cookbook/expression/expressions.rst
@@ -33,11 +33,9 @@ accepts an :class:`Symfony\\Component\\ExpressionLanguage\\Expression` object::
 
     public function indexAction()
     {
-        if (!$this->get('security.authorization_checker')->isGranted(new Expression(
+        $this->denyAccessUnlessGranted(new Expression(
             '"ROLE_ADMIN" in roles or (user and user.isSuperAdmin())'
-        ))) {
-            throw $this->createAccessDeniedException();
-        }
+        ));
 
         // ...
     }
diff --git a/cookbook/form/direct_submit.rst b/cookbook/form/direct_submit.rst
@@ -25,7 +25,7 @@ submissions::
         if ($form->isValid()) {
             // perform some action...
 
-            return $this->redirect($this->generateUrl('task_success'));
+            return $this->redirectToRoute('task_success');
         }
 
         return $this->render('AcmeTaskBundle:Default:new.html.twig', array(
@@ -66,7 +66,7 @@ method, pass the submitted data directly to
             if ($form->isValid()) {
                 // perform some action...
 
-                return $this->redirect($this->generateUrl('task_success'));
+                return $this->redirectToRoute('task_success');
             }
         }
 
@@ -111,7 +111,7 @@ a convenient shortcut to the previous example::
             if ($form->isValid()) {
                 // perform some action...
 
-                return $this->redirect($this->generateUrl('task_success'));
+                return $this->redirectToRoute('task_success');
             }
         }
 
diff --git a/cookbook/form/form_collections.rst b/cookbook/form/form_collections.rst
@@ -717,7 +717,7 @@ the relationship between the removed ``Tag`` and ``Task`` object.
                 $em->flush();
 
                 // redirect back to some edit page
-                return $this->redirect($this->generateUrl('task_edit', array('id' => $id)));
+                return $this->redirectToRoute('task_edit', array('id' => $id));
             }
 
             // render some form template
diff --git a/cookbook/security/remember_me.rst b/cookbook/security/remember_me.rst
@@ -162,19 +162,11 @@ In the following example, the action is only allowed if the user has the
 
     public function editAction()
     {
-        if (false === $this->get('security.authorization_checker')->isGranted(
-            'IS_AUTHENTICATED_FULLY'
-           )) {
-            throw new AccessDeniedException();
-        }
+        $this->denyAccessUnlessGranted('IS_AUTHENTICATED_FULLY');
 
         // ...
     }
 
-.. versionadded:: 2.6
-    The ``security.authorization_checker`` service was introduced in Symfony 2.6. Prior
-    to Symfony 2.6, you had to use the ``isGranted()`` method of the ``security.context`` service.
-
 If your application is based on the Symfony Standard Edition, you can also secure
 your controller using annotations:
 
diff --git a/cookbook/security/securing_services.rst b/cookbook/security/securing_services.rst
@@ -5,41 +5,34 @@
 How to Secure any Service or Method in your Application
 =======================================================
 
-In the security chapter, you can see how to :ref:`secure a controller <book-security-securing-controller>`
-by requesting the ``security.authorization_checker`` service from the Service Container
-and checking the current user's role::
+In the security chapter, you can see how to
+:ref:`secure a controller <book-security-securing-controller>` by requesting
+the ``security.authorization_checker`` service from the Service Container and
+checking the current user's role::
 
     // ...
     use Symfony\Component\Security\Core\Exception\AccessDeniedException;
 
     public function helloAction($name)
     {
-        if (false === $this->get('security.authorization_checker')->isGranted('ROLE_ADMIN')) {
-            throw new AccessDeniedException();
-        }
+        $this->denyAccessUnlessGranted('ROLE_ADMIN');
 
         // ...
     }
 
-.. versionadded:: 2.6
-    The ``security.authorization_checker`` service was introduced in Symfony 2.6. Prior
-    to Symfony 2.6, you had to use the ``isGranted()`` method of the ``security.context`` service.
-
-You can also secure *any* service in a similar way by injecting the ``security.authorization_checker``
+You can also secure *any* service by injecting the ``security.authorization_checker``
 service into it. For a general introduction to injecting dependencies into
 services see the :doc:`/book/service_container` chapter of the book. For
 example, suppose you have a ``NewsletterManager`` class that sends out emails
-and you want to restrict its use to only users who have some ``ROLE_NEWSLETTER_ADMIN``
-role. Before you add security, the class looks something like this:
-
-.. code-block:: php
+and you want to restrict its use to only users who have some
+``ROLE_NEWSLETTER_ADMIN`` role. Before you add security, the class looks
+something like this::
 
     // src/AppBundle/Newsletter/NewsletterManager.php
     namespace AppBundle\Newsletter;
 
     class NewsletterManager
     {
-
         public function sendNewsletter()
         {
             // ... where you actually do the work
@@ -55,8 +48,9 @@ check, this is an ideal candidate for constructor injection, which guarantees
 that the authorization checker object will be available inside the ``NewsletterManager``
 class::
 
-    namespace AppBundle\Newsletter;
+    // src/AppBundle/Newsletter/NewsletterManager.php
 
+    // ...
     use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 
     class NewsletterManager

Original file line number	Diff line number	Diff line change
`@@ -667,7 +667,7 @@ you have a route that maps a product id to an update action in a controller::`
`667`	`667`	`$product->setName('New product name!');`
`668`	`668`	`$em->flush();`
`669`	`669`
`670`		`- return $this->redirect($this->generateUrl('homepage'));`
	`670`	`+ return $this->redirectToRoute('homepage');`
`671`	`671`	`}`
`672`	`672`
`673`	`673`	`Updating an object involves just three steps:`
Original file line number	Diff line number	Diff line change
`@@ -234,7 +234,7 @@ controller::`
`234`	`234`	`if ($form->isValid()) {`
`235`	`235`	`// perform some action, such as saving the task to the database`
`236`	`236`
`237`		`- return $this->redirect($this->generateUrl('task_success'));`
	`237`	`+ return $this->redirectToRoute('task_success');`
`238`	`238`	`}`
`239`	`239`
`240`	`240`	`// ...`
`@@ -319,7 +319,7 @@ querying if the "Save and add" button was clicked::`
`319`	`319`	`? 'task_new'`
`320`	`320`	`: 'task_success';`
`321`	`321`
`322`		`- return $this->redirect($this->generateUrl($nextAction));`
	`322`	`+ return $this->redirectToRoute($nextAction);`
`323`	`323`	`}`
`324`	`324`
`325`	`325`	`.. index::`
`@@ -1233,7 +1233,7 @@ it after a form submission can be done when the form is valid::`
`1233`	`1233`	`$em->persist($task);`
`1234`	`1234`	`$em->flush();`
`1235`	`1235`
`1236`		`- return $this->redirect($this->generateUrl('task_success'));`
	`1236`	`+ return $this->redirectToRoute('task_success');`
`1237`	`1237`	`}`
`1238`	`1238`
`1239`	`1239`	If, for some reason, you don't have access to your original ``$task`` object,
Original file line number	Diff line number	Diff line change
`@@ -241,11 +241,15 @@ have a route that maps a product id to an update action in a controller::`
`241`	`241`	`);`
`242`	`242`	`}`
`243`	`243`
	`244`	`+<<<<<<< HEAD`
`244`	`245`	`$product->setName('New product name!');`
`245`	`246`	`$product->save();`
`246`	`247`
`247`	`248`	`return $this->redirect($this->generateUrl('homepage'));`
`248`	`249`	`}`
	`250`	`+=======`
	`251`	`+ return $this->redirectToRoute('homepage');`
	`252`	`+>>>>>>> pull/5046`
`249`	`253`	`}`
`250`	`254`
`251`	`255`	`Updating an object involves just three steps:`
Original file line number	Diff line number	Diff line change
`@@ -232,7 +232,7 @@ workflow looks like the following from inside a controller::`
`232`	`232`	`if ($form->isValid()) {`
`233`	`233`	`// the validation passed, do something with the $author object`
`234`	`234`
`235`		`- return $this->redirect($this->generateUrl(...));`
	`235`	`+ return $this->redirectToRoute(...);`
`236`	`236`	`}`
`237`	`237`
`238`	`238`	`return $this->render('author/form.html.twig', array(`
Original file line number	Diff line number	Diff line change
`@@ -587,7 +587,7 @@ method:`
`587`	`587`
`588`	`588`	`// ... perform some action, such as saving the data to the database`
`589`	`589`
`590`		`- return $this->redirect($this->generateUrl('task_success'));`
	`590`	`+ return $this->redirectToRoute('task_success');`
`591`	`591`	`}`
`592`	`592`
`593`	`593`	`// ...`
Original file line number	Diff line number	Diff line change
`@@ -244,7 +244,7 @@ The following controller shows you how to handle the entire process::`
`244`	`244`	`$em->persist($document);`
`245`	`245`	`$em->flush();`
`246`	`246`
`247`		`- return $this->redirect($this->generateUrl(...));`
	`247`	`+ return $this->redirectToRoute(...);`
`248`	`248`	`}`
`249`	`249`
`250`	`250`	`return array('form' => $form->createView());`
`@@ -267,7 +267,7 @@ in a moment to handle the file upload::`
`267`	`267`	`$em->persist($document);`
`268`	`268`	`$em->flush();`
`269`	`269`
`270`		`- return $this->redirect(...);`
	`270`	`+ return $this->redirectToRoute(...);`
`271`	`271`	`}`
`272`	`272`
`273`	`273`	The ``upload()`` method will take advantage of the :class:`Symfony\\Component\\HttpFoundation\\File\\UploadedFile`
@@ -432,7 +432,7 @@ call to ``$document->upload()`` should be removed from the controller::
`432`	`432`	`$em->persist($document);`
`433`	`433`	`$em->flush();`
`434`	`434`
`435`		`- return $this->redirect(...);`
	`435`	`+ return $this->redirectToRoute(...);`
`436`	`436`	`}`
`437`	`437`
`438`	`438`	`.. note::`
Original file line number	Diff line number	Diff line change
`@@ -287,7 +287,7 @@ the validation and saves the data into the database::`
`287`	`287`	`$em->persist($registration->getUser());`
`288`	`288`	`$em->flush();`
`289`	`289`
`290`		`- return $this->redirect(...);`
	`290`	`+ return $this->redirectToRoute(...);`
`291`	`291`	`}`
`292`	`292`
`293`	`293`	`return $this->render(`
Original file line number	Diff line number	Diff line change
@@ -33,11 +33,9 @@ accepts an :class:`Symfony\\Component\\ExpressionLanguage\\Expression` object::
`33`	`33`
`34`	`34`	`public function indexAction()`
`35`	`35`	`{`
`36`		`- if (!$this->get('security.authorization_checker')->isGranted(new Expression(`
	`36`	`+ $this->denyAccessUnlessGranted(new Expression(`
`37`	`37`	`'"ROLE_ADMIN" in roles or (user and user.isSuperAdmin())'`
`38`		`- ))) {`
`39`		`- throw $this->createAccessDeniedException();`
`40`		`- }`
	`38`	`+ ));`
`41`	`39`
`42`	`40`	`// ...`
`43`	`41`	`}`