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 6 commits
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
18 changes: 7 additions & 11 deletions book/controller.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,28 +423,24 @@ to manage in Symfony2.
Redirecting
~~~~~~~~~~~

If you want to redirect the user to another page, use the ``redirect()`` method::
If you want to redirect the user to another page, use the ``redirectToRoute()`` method::
Copy link
Member

Choose a reason for hiding this comment

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

We need a versionadded:: 2.6 block above this:

.. 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 below).


public function indexAction()
{
return $this->redirect($this->generateUrl('homepage'));
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.

Ah, actually, since this is the first example showing redirectToRoute, we should put the commented-out example showing redirect() and generateUrl() (the code block I added in my comment here: https://github.com/symfony/symfony-docs/pull/4109/files#r22320539) to this code block, not the one below.

}

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.

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', 301);
}

.. tip::

Copy link
Contributor

Choose a reason for hiding this comment

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

if we remove this, we have to document the generateUrl and the redirect method? redirectToRoute won't replace both?

Copy link
Member

Choose a reason for hiding this comment

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

redirect() is now only useful when you know the URL you want to redirect to and don't have to generate it (redirecting to an external URL for example). I'm not really sure if there really is a use case for generateUrl() any more.

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 we should show both, the second one commented out. So, something like:

public function indexAction()
{
    // redirectToRoute is equivalent to using redirect() and generateUrl() together:
    // return $this->redirect($this->generateUrl('homepage'), 301);

    return $this->redirectToRoute('homepage', 301);
}

And then we can add one more thing right below this code block

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');
    }

Copy link
Contributor

Choose a reason for hiding this comment

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

there is no reason to not document generateUrl and redirect.

The ``redirect()`` method is simply a shortcut that creates a ``Response``
The ``redirectToRoute()`` method is simply a shortcut that creates a ``Response``
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 we should keep this as redirect()

object that specializes in redirecting the user. It's equivalent to::

use Symfony\Component\HttpFoundation\RedirectResponse;
Expand Down Expand Up @@ -705,12 +701,12 @@ For example, imagine you're processing a form submit::
if ($form->isValid()) {
// do some sort of processing

$this->get('session')->getFlashBag()->add(
$this->addFlash(
'notice',
'Your changes were saved!'
);
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 as with redirectToRoute, I think we should show the "old" (or manual) way of doing this commented-out. This will help users know what's really going on and how they might add a flash message if they were not in a controller.


return $this->redirect($this->generateUrl(...));
return $this->redirectToRoute(...);
}

return $this->render(...);
Expand Down
2 changes: 1 addition & 1 deletion book/doctrine.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -675,7 +675,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:
Expand Down
6 changes: 3 additions & 3 deletions book/forms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,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');
}

// ...
Expand Down Expand Up @@ -304,7 +304,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::
Expand Down Expand Up @@ -1197,7 +1197,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,
Expand Down
2 changes: 1 addition & 1 deletion book/propel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ have a route that maps a product id to an update action in a controller::
$product->setName('New product name!');
$product->save();

return $this->redirect($this->generateUrl('homepage'));
return $this->redirectToRoute('homepage');
}

Updating an object involves just three steps:
Expand Down
14 changes: 4 additions & 10 deletions book/security.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1092,9 +1092,7 @@ authorization from inside a controller::

public function helloAction($name)
{
if (false === $this->get('security.context')->isGranted('ROLE_ADMIN')) {
throw $this->createAccessDeniedException('Unable to access this page!');
}
$this->denyAccessUnlessGranted('ROLE_ADMIN', null, 'Unable to access this page!');
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 - I'd like to show the "old" way (which would now use the security.authorization_checker service in 2.6) in a comment.

Copy link
Member

Choose a reason for hiding this comment

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

And we need a versionadded note above this:

.. versionadded:: 2.6
    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 below).

Copy link
Member

Choose a reason for hiding this comment

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

Maybe we should add a brief explanation of the weird null middle argument?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's right.


// ...
}
Expand Down Expand Up @@ -1736,9 +1734,7 @@ authorization from inside a controller::

public function helloAction($name)
{
if (false === $this->get('security.context')->isGranted('ROLE_ADMIN')) {
throw new AccessDeniedException();
}
$this->denyAccessUnlessGranted('ROLE_ADMIN');

// ...
}
Expand Down Expand Up @@ -1766,11 +1762,9 @@ accepts an :class:`Symfony\\Component\\ExpressionLanguage\\Expression` object::

public function indexAction()
{
if (!$this->get('security.context')->isGranted(new Expression(
$this->denyAccessUnlessGranted(new Expression(
'"ROLE_ADMIN" in roles or (user and user.isSuperAdmin())'
))) {
throw new AccessDeniedException();
}
));

// ...
}
Expand Down
2 changes: 1 addition & 1 deletion book/validation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,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('BlogBundle:Author:form.html.twig', array(
Expand Down
2 changes: 1 addition & 1 deletion components/form/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,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');
}

// ...
Expand Down
6 changes: 3 additions & 3 deletions cookbook/doctrine/file_uploads.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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());
Expand All @@ -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`
Expand Down Expand Up @@ -431,7 +431,7 @@ call to ``$document->upload()`` should be removed from the controller::
$em->persist($document);
$em->flush();

return $this->redirect(...);
return $this->redirectToRoute(...);
}

.. note::
Expand Down
2 changes: 1 addition & 1 deletion cookbook/doctrine/registration_form.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
6 changes: 3 additions & 3 deletions cookbook/form/direct_submit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down Expand Up @@ -64,7 +64,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');
}
}

Expand Down Expand Up @@ -109,7 +109,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');
}
}

Expand Down
2 changes: 1 addition & 1 deletion cookbook/form/form_collections.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -713,7 +713,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
Expand Down
6 changes: 1 addition & 5 deletions cookbook/security/remember_me.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,11 +162,7 @@ In the following example, the action is only allowed if the user has the

public function editAction()
{
if (false === $this->get('security.context')->isGranted(
'IS_AUTHENTICATED_FULLY'
)) {
throw new AccessDeniedException();
}
$this->denyAccessUnlessGranted('IS_AUTHENTICATED_FULLY');

// ...
}
Expand Down
4 changes: 1 addition & 3 deletions cookbook/security/securing_services.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ and checking the current user's role::

public function helloAction($name)
{
if (false === $this->get('security.context')->isGranted('ROLE_ADMIN')) {
throw new AccessDeniedException();
}
$this->denyAccessUnlessGranted('ROLE_ADMIN');

// ...
}
Expand Down
10 changes: 3 additions & 7 deletions quick_tour/the_controller.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,10 @@ requirement.
Redirecting and Forwarding
--------------------------

If you want to redirect the user to another page, use the ``redirect()``
If you want to redirect the user to another page, use the ``redirectToRoute()``
method::

return $this->redirect($this->generateUrl('_demo_hello', array('name' => 'Lucas')));

The ``generateUrl()`` is the same method as the ``path()`` function used in the
templates. It takes the route name and an array of parameters as arguments and
returns the associated friendly URL.
return $this->redirectToRoute('_demo_hello', array('name' => 'Lucas'));

You can also internally forward the action to another using the ``forward()``
method::
Expand Down Expand Up @@ -165,7 +161,7 @@ They are useful when you need to set a success message before redirecting the
user to another page (which will then show the message)::

// store a message for the very next request (in a controller)
$session->getFlashBag()->add('notice', 'Congratulations, your action succeeded!');
$this->addFlash('notice', 'Congratulations, your action succeeded!');

.. code-block:: html+jinja

Expand Down