Skip to content

Added shortcut methods for controllers #4109

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

Closed
wants to merge 9 commits into from
Closed

Added shortcut methods for controllers #4109

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ccc6384
Added shortcut methods for controllers
Cydonia7 Aug 8, 2014
3b03455
Minor format improvements
Cydonia7 Aug 8, 2014
675877d
Minor improvements
Cydonia7 Aug 8, 2014
0366a0c
redirect changed to redirectToRoute
Cydonia7 Sep 30, 2014
8b23729
Changed to addFlash where it is possible (ie in controllers)
Cydonia7 Sep 30, 2014
4a54c5f
And now the same for isGranted where it is possible
Cydonia7 Sep 30, 2014
cded08b
Merge branch 'master' into add-shortcut-methods
Cydonia7 Jan 4, 2015
6db9c11
Modifications according to comments
Cydonia7 Jan 4, 2015
0758d62
Fixes
Cydonia7 Jan 4, 2015
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
8 changes: 8 additions & 0 deletions book/controller.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,6 +451,10 @@ perform a 301 (permanent) redirect, modify the second argument::

return new RedirectResponse($this->generateUrl('homepage'));

You can also directly use ``redirectToRoute()`` and give it directly the route name like :
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can link directly to the API docs (instead of redirectToRoute()):

:method:`Symfony\\Bundle\\FrameworkBundle\\Controller::redirectToRoute``


return $this->redirectToRoute('homepage');

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we should replace all $this->redirect with this new $this->redirectToRoute. I want to show people the easiest way of doing things. In the versionadded, we can say something like:

.. versionadded:: 2.6
    The ``redirectToRoute()`` shortcut method was added in Symfony 2.6. The longer way, which
    involves using `generateUrl()` and creating a 
    :class:`Symfony\\Component\\HttpFoundation\\RedirectResponse` object, still works like before.

.. index::
single: Controller; Forwarding

Expand Down Expand Up @@ -720,6 +724,10 @@ After processing the request, the controller sets a ``notice`` flash message
and then redirects. The name (``notice``) isn't significant - it's just what
you're using to identify the type of the message.

.. tip::

You can use the ``addFlash(...)`` method as a shortcut to ``$this->get('session')->getFlashBag()->add(...)``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here and you should split lines after the first word that crosses the 72nd character


Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same thing here - we should replace all the old code with the new addFlash method

In the template of the next action, the following code could be used to render
the ``notice`` message:

Expand Down
5 changes: 5 additions & 0 deletions book/security.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1124,6 +1124,11 @@ Thanks to the SensioFrameworkExtraBundle, you can also secure your controller us
For more information, see the
:doc:`FrameworkExtraBundle documentation </bundles/SensioFrameworkExtraBundle/annotations/security>`.

.. tip::

You can use directly `$this->isGranted($role)` instead of `$this->get('security.context')->isGranted($role)` to check if
a role is granted and `denyAccessUnlessGranted` to throw an exception if the access is not granted (like in the example above).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here


Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And same here, let's use the shortcut methods everywhere

Securing other Services
~~~~~~~~~~~~~~~~~~~~~~~

Expand Down