Added shortcut methods for controllers #4109

Cydonia7 · 2014-08-08T14:41:50Z

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.

stof · 2014-08-08T14:46:30Z

you should add ..versionadded:: 2.6, as new features can only be added in the next version (and given the timeframe, there is a high chance that it will not be postponed to 2.7)

xabbuh · 2014-08-08T14:46:54Z

Actually, this isn't a bug fix but a new feature. So, the pull request description would usually look something like this:

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes (symfony/symfony#11593)
| Applies to    | 2.6+
| Fixed tickets |

xabbuh · 2014-08-08T14:48:37Z

book/controller.rst

@@ -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 :


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

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

xabbuh · 2014-08-08T14:51:38Z

@Cydonia7 Besides these minor improvements, your pull request looks really good! 👍

…(Cydonia7) This PR was merged into the 2.6-dev branch. Discussion ---------- [FrameworkBundle] Add shortcut methods to controllers | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #11166 | License | MIT | Doc PR | symfony/symfony-docs#4109 To-do list : - [x] submit changes to the documentation Added redirectToRoute, addFlash, isGranted and checkGranted to controllers. The code seems so simple I didn't feel like adding controller tests was needed since we're just shortcuting other services calls. Commits ------- 74d8c9a Add redirectToRoute, addFlash, isGranted and denyAccessUnlessGranted shortcuts to controllers.

xabbuh · 2014-09-19T07:32:11Z

The code pull request has been merged.

weaverryan · 2014-09-19T17:45:31Z

book/controller.rst

+    and give it directly the route name like :
+
+        return $this->redirectToRoute('homepage');
+


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.

weaverryan · 2014-09-19T17:47:55Z

Hey Thomas!

Congrats on getting the PR merged into core - I was very excited about it! The docs PR actually needs to be much more involved. As I've commented, instead of just mentioning the new methods, I'd like to actually use the new methods through the docs and not use the old ways. This means that this PR is quite a bit more difficult. If you want to try updating everything, awesome! If you'd rather have one of the core contributors take over this PR, that's no problem :).

Thanks!

Cydonia7 · 2014-09-20T17:07:50Z

I think I can handle that :) Thanks for your help throughout the PRs!

…(Cydonia7) This PR was merged into the 2.6-dev branch. Discussion ---------- [FrameworkBundle] Add shortcut methods to controllers | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #11166 | License | MIT | Doc PR | symfony/symfony-docs#4109 To-do list : - [x] submit changes to the documentation Added redirectToRoute, addFlash, isGranted and checkGranted to controllers. The code seems so simple I didn't feel like adding controller tests was needed since we're just shortcuting other services calls. Commits ------- 74d8c9a Add redirectToRoute, addFlash, isGranted and denyAccessUnlessGranted shortcuts to controllers.

Cydonia7 · 2014-09-30T07:31:23Z

After changing so much documentation, I have to admit I am quite surprised about how many times it was used throughout the docs but here it is, I think I am done with this PR.

Waiting for your feedback.

Cydonia7 · 2014-10-23T08:33:17Z

Any update on this ?

xabbuh · 2014-10-23T08:36:45Z

It would be better to add versionadded directives to not confuse people using older Symfony versions when reading the changed documents.

weaverryan · 2014-12-29T17:46:42Z

book/controller.rst

@@ -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::


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

weaverryan · 2014-12-29T17:51:43Z

Thanks @wouterj for the ping - this had fallen off of my radar. @Cydonia7 do you have some time to take a look at the notes I just added?

Thanks!

Cydonia7 · 2014-12-30T10:17:47Z

I will give it a look when I come home in a few days. Thanks @weaverryan !

Conflicts: book/controller.rst book/security.rst cookbook/security/remember_me.rst cookbook/security/securing_services.rst quick_tour/the_controller.rst

Cydonia7 · 2015-01-04T11:19:33Z

@weaverryan I think I've changed it all, would you please take a look?

xabbuh · 2015-01-04T12:13:15Z

book/security.rst

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


I would move it above the paragraph (right below the "Securing a Controller" headline).

Cydonia7 · 2015-01-04T14:51:01Z

I fixed the issues @xabbuh @javiereguiluz

xabbuh · 2015-01-04T15:01:35Z

book/security.rst

+the one seen in the previous section. For example, suppose you have a service
+(i.e. a PHP class) whose job is to send emails from one user to another.
+You can restrict use of this class - no matter where it's being used from -
+to users that have a specific role.


The following code block doesn't really belong to this paragraph.

javiereguiluz · 2015-01-23T13:43:18Z

Could we made a final effort to complete this PR? It would be nice to show and use the new shortcuts, but I understand that the PR is so big and complex that is taking forever to complete :( If there is much work to do, could we create another separate PR?

Cydonia7 · 2015-01-23T14:35:20Z

What is needed to "complete" it ?

weaverryan · 2015-02-07T18:53:28Z

Ah, we're clearly waiting on me only! I'll put this on my primary list and so will review and merge very soon. Sorry for being in the way here!

weaverryan · 2015-02-25T23:09:54Z

book/controller.rst

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


(see the example above)

weaverryan · 2015-02-25T23:16:01Z

Hey @Cydonia7!

Sorry for the delay on my end. I just need one more thing from you. I added a really easy comment, but what I really need is a rebase. I need to merge this into the 2.6 branch, which is conflicting in the security chapter. You can kind of see it here - the changes to security.rst are too big. If you search for _book-security-securing-controller, you'll see that after your commits, there are 2 of these sections. This is due to a big refatoring of the security chapter, so it's my fault for making your life difficult.

Would you be able to rebase? The result should be that security.rst has less changes (i.e. it doesn't look like you added a new section).

Thanks!

Cydonia7 · 2015-02-26T08:02:09Z

I tried and didn't manage to do it for now... The rebase is so complex I can't even understand what I am doing sometimes (I've had to do like 5 times rebase --continue and changing commits I didn't even authored).

So what should I do ?

xabbuh · 2015-02-26T08:56:24Z

@Cydonia7 If you were able to join #symfony-docs on IRC, someone could probably be able to help you. Otherwise, if you don't mind, we can take your changes, rebase them and create a new PR for you.

Cydonia7 · 2015-02-26T09:06:47Z

I won't have time during the next week to do this but I don't mind, you can create a new PR with my changes.

wouterj · 2015-02-26T09:07:09Z

Okay, I'll try :)

Cydonia7 · 2015-02-26T09:08:01Z

Thanks @wouterj, I didn't think I would have such a hard time rebasing this...

stof · 2015-02-26T09:12:09Z

@Cydonia7 if you are changing commits you have not authored, it means you are doing the wrong rebase. You should rebase your own feature branch, not the symfony branch.

wouterj · 2015-02-26T11:30:45Z

Closing in favor of #5046 (and indeed, it was a hell of a rebase, literally every change in this PR was conflicting...)

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

Added shortcut methods for controllers

ccc6384

xabbuh reviewed Aug 8, 2014
View reviewed changes

Cydonia7 added 2 commits August 8, 2014 17:12

Minor format improvements

3b03455

Minor improvements

675877d

wouterj added the Stalled label Aug 15, 2014

Cydonia7 mentioned this pull request Aug 17, 2014

[FrameworkBundle] Add shortcut methods to controllers symfony/symfony#11593

Merged

1 task

xabbuh changed the title ~~[WCM] Added shortcut methods for controllers~~ Added shortcut methods for controllers Sep 19, 2014

xabbuh added Status: Reviewed and removed On hold labels Sep 19, 2014

weaverryan reviewed Sep 19, 2014
View reviewed changes

weaverryan added Status: Needs Work and removed Status: Reviewed labels Sep 19, 2014

Cydonia7 added 3 commits September 30, 2014 09:18

redirect changed to redirectToRoute

0366a0c

Changed to addFlash where it is possible (ie in controllers)

8b23729

And now the same for isGranted where it is possible

4a54c5f

weaverryan reviewed Dec 29, 2014
View reviewed changes

Cydonia7 added 2 commits January 4, 2015 12:11

Merge branch 'master' into add-shortcut-methods

cded08b

Conflicts: book/controller.rst book/security.rst cookbook/security/remember_me.rst cookbook/security/securing_services.rst quick_tour/the_controller.rst

Modifications according to comments

6db9c11

xabbuh reviewed Jan 4, 2015
View reviewed changes

Fixes

0758d62

xabbuh reviewed Jan 4, 2015
View reviewed changes

weaverryan reviewed Feb 25, 2015
View reviewed changes

wouterj mentioned this pull request Feb 26, 2015

Rebased "add shortcut methods" #5046

Merged

wouterj closed this Feb 26, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added shortcut methods for controllers #4109

Added shortcut methods for controllers #4109

Cydonia7 commented Aug 8, 2014

stof commented Aug 8, 2014

xabbuh commented Aug 8, 2014

xabbuh Aug 8, 2014

xabbuh commented Aug 8, 2014

xabbuh commented Sep 19, 2014

weaverryan Sep 19, 2014

weaverryan commented Sep 19, 2014

Cydonia7 commented Sep 20, 2014

Cydonia7 commented Sep 30, 2014

Cydonia7 commented Oct 23, 2014

xabbuh commented Oct 23, 2014

weaverryan Dec 29, 2014

weaverryan commented Dec 29, 2014

Cydonia7 commented Dec 30, 2014

Cydonia7 commented Jan 4, 2015

xabbuh Jan 4, 2015

Cydonia7 commented Jan 4, 2015

xabbuh Jan 4, 2015

javiereguiluz commented Jan 23, 2015

Cydonia7 commented Jan 23, 2015

weaverryan commented Feb 7, 2015

weaverryan Feb 25, 2015

weaverryan commented Feb 25, 2015

Cydonia7 commented Feb 26, 2015

xabbuh commented Feb 26, 2015

Cydonia7 commented Feb 26, 2015

wouterj commented Feb 26, 2015

Cydonia7 commented Feb 26, 2015

stof commented Feb 26, 2015

wouterj commented Feb 26, 2015

		@@ -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 :

		and give it directly the route name like :

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

Added shortcut methods for controllers #4109

Added shortcut methods for controllers #4109

Conversation

Cydonia7 commented Aug 8, 2014

stof commented Aug 8, 2014

xabbuh commented Aug 8, 2014

xabbuh Aug 8, 2014

Choose a reason for hiding this comment

xabbuh commented Aug 8, 2014

xabbuh commented Sep 19, 2014

weaverryan Sep 19, 2014

Choose a reason for hiding this comment

weaverryan commented Sep 19, 2014

Cydonia7 commented Sep 20, 2014

Cydonia7 commented Sep 30, 2014

Cydonia7 commented Oct 23, 2014

xabbuh commented Oct 23, 2014

weaverryan Dec 29, 2014

Choose a reason for hiding this comment

weaverryan commented Dec 29, 2014

Cydonia7 commented Dec 30, 2014

Cydonia7 commented Jan 4, 2015

xabbuh Jan 4, 2015

Choose a reason for hiding this comment

Cydonia7 commented Jan 4, 2015

xabbuh Jan 4, 2015

Choose a reason for hiding this comment

javiereguiluz commented Jan 23, 2015

Cydonia7 commented Jan 23, 2015

weaverryan commented Feb 7, 2015

weaverryan Feb 25, 2015

Choose a reason for hiding this comment

weaverryan commented Feb 25, 2015

Cydonia7 commented Feb 26, 2015

xabbuh commented Feb 26, 2015

Cydonia7 commented Feb 26, 2015

wouterj commented Feb 26, 2015

Cydonia7 commented Feb 26, 2015

stof commented Feb 26, 2015

wouterj commented Feb 26, 2015