Added docs about ArgumentValueResolvers #6438

linaori · 2016-04-06T14:47:01Z

Q	A
Doc fix?	no
New docs?	yes
Applies to	3.1
Fixed tickets	~

Adds the documentation for the new ArgumentValueResolver feature from symfony/symfony#18308.

wouterj · 2016-04-06T14:51:17Z

cookbook/controller/argument_value_resolver.rst

+   action in the forementioned functionality.
+
+ - The :class:``Symfony\\Component\\HttpKernel\\ControllerMetadata\\ArgumentMetadata`` represents
+   information retrieved from the method signature for the current argument it's trying to resolve.


Lists shouldn't be indented with one space in reSt, it'll end up as a blockquote. Also, please use * to be consistent with the other lists in the documentation.

wouterj · 2016-04-06T15:24:17Z

cookbook/controller/argument_value_resolver.rst

+    The ``ArgumentResolver`` and value resolvers are added in Symfony 3.1.
+
+In the book, you've learned that you can add the :class:`Symfony\\Component\\HttpFoundation\\Request`
+as action argument and it will be injected into the method. This is done via the


Maybe "In the book, you've learned that you can get the Request object by adding a Request argument to your controller."?

wouterj · 2016-04-06T15:41:32Z

Thank you for writing the docs, @iltar! It's looking great. I'm afraid I've decorated your PR a bit with some comments, but they are mostly minor style comments.

fabpot · 2016-04-10T17:04:59Z

cookbook/controller/argument_value_resolver.rst

+
+    Prior to Symfony 3.1, this logic was resolved within the ``ControllerResolver``. The old
+    functionality is moved to the ``LegacyArgumentResolver``, which contains the previously
+    used resolving logic.


If #18495 is merged, the legacy class won't exist anymore.

linaori · 2016-04-11T06:30:10Z

@fabpot in the example I'm writing the UserValueResolver which I've based on the PR in the SensioFrameworkExtraBundle. While we're at the subject, should I add this code to a PR for 3.1, wait for 3.2 or is this something specific enough that people should implement them self?

fabpot · 2016-04-11T12:38:29Z

I think it makes sense to add this feature directly in Symfony... that's one reason we made things more flexible. Submit this to master, that could be merged into 3.1 or 3.2.

linaori · 2016-04-29T13:52:03Z

I've rebased against the current master and added the fixes in 55a87b5

wouterj · 2016-04-29T15:19:52Z

cookbook/controller/argument_value_resolver.rst

+    is resolved, you must `yield`_ the value to the ``ArgumentResolver``.
+
+Both methods get the ``Request`` object, which is the current request, and an
+:class:`Symfony\\Component\\HttpKernel\\ControllerMetadata\\ArgumentMetadata`.


I would add "instance" in this sentence: "Both methods get [...] and an ArgumentMetadata instance"

linaori · 2016-05-06T06:05:10Z

Any last checks? I'd say this is ready to be merged 😄

xabbuh · 2016-05-14T09:40:42Z

cookbook/controller/argument_value_resolver.rst

+    The ``ArgumentResolver`` and value resolvers were introduced in Symfony 3.1.
+
+In the book, you've learned that you can get the :class:`Symfony\\Component\\HttpFoundation\\Request`
+object via an argument in your controller. This argument has to be typehinted


type-hinted

xabbuh · 2016-05-21T10:47:00Z

This looks ready to me. 👍

This PR was submitted for the master branch but it was merged into the 3.1 branch instead (closes #6438). Discussion ---------- Added docs about ArgumentValueResolvers | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | 3.1 | Fixed tickets | ~ Adds the documentation for the new `ArgumentValueResolver` feature from symfony/symfony#18308. Commits ------- f22dc96 Added docs about ArgumentValueResolvers

wouterj · 2016-06-11T19:59:06Z

Thank you @iltar! I've merged your PR in the 3.1 branch.

I've proofread the article and fixed some class names, typos. I've also removed the section about optional value resolvers and replaced it with a tip directive. I don't think it's needed to use so much words to explain it.

If you have some time, please review the changes in 66ce882 (please note that I also line wrapped some paragraphs, the diff looks way bigger than the actual changes).

linaori · 2016-06-12T09:07:50Z

@wouterj I've found 2 small issues but that's about it, looks good to me!

This PR was merged into the 3.1 branch. Discussion ---------- [#6438] some tweaks to the argument value resolver Commits ------- 2cdd6dc [#6438] some tweaks to the argument value resolver

This PR was merged into the 3.2-dev branch. Discussion ---------- Added a SecurityUserValueResolver for controllers | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | ~ | License | MIT | Doc PR | ~ This PR uses the new `ArgumentResolver` to inject a security user when the signature implies so. This is based on the [docs code example](symfony/symfony-docs#6438 (comment)) and [existing pr on the SFEB](sensiolabs/SensioFrameworkExtraBundle#327). With the new example you can do the following: ```php // when a User is mandatory, e.g. behind firewall public function fooAction(UserInterface $user) // when a User is optional, e.g. where it can be anonymous public function barAction(UserInterface $user = null) ``` This deprecates the `Controller::getUser()` method. I have added it on a priority of 40 so it falls just under the `RequestValueResolver`. This is because it's already used and the initial performance is less of an impact. There was a comment asking if the `controller_argument.value_resolver` tag name wasn't too long. If decided this tag should change before 3.1 is released, I will update it in here. *`RequestValueResolver` contains a small codestyle consistency fix.* Commits ------- d341889 Added a SecurityUserValueResolver for controllers

wouterj reviewed Apr 6, 2016
View reviewed changes

linaori force-pushed the feature/argument-value-resolvers branch from a1d55d2 to a310bbc Compare April 6, 2016 15:10

wouterj reviewed Apr 6, 2016
View reviewed changes

wouterj added the Status: Needs Work label Apr 6, 2016

xabbuh mentioned this pull request Apr 6, 2016

Documented the ArgumentResolver along the ControllerResolver #6422

Closed

fabpot reviewed Apr 10, 2016
View reviewed changes

Iltar van der Berg added 2 commits April 29, 2016 15:46

Tried to make the default value resolving more clear

e3d1b48

Minor fixes

55a87b5

linaori force-pushed the feature/argument-value-resolvers branch from fdce9c6 to 55a87b5 Compare April 29, 2016 13:51

wouterj reviewed Apr 29, 2016
View reviewed changes

Added instance

8d30575

xabbuh added this to the 3.1 milestone May 14, 2016

xabbuh reviewed May 14, 2016
View reviewed changes

Iltar van der Berg added 3 commits May 17, 2016 08:16

Feedback from PR

dd225e8

Fixed sub-title case

ca014a6

typehinted > type-hinted

14d77e1

wouterj added the Hack Day label May 21, 2016

xabbuh added Status: Reviewed and removed Status: Needs Work labels May 21, 2016

wouterj added a commit that referenced this pull request Jun 11, 2016

[#6438] Fix class names and shorten article after merging

66ce882

wouterj closed this Jun 11, 2016

xabbuh added a commit that referenced this pull request Jun 13, 2016

[#6438] some tweaks to the argument value resolver

2cdd6dc

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added docs about ArgumentValueResolvers #6438

Added docs about ArgumentValueResolvers #6438

linaori commented Apr 6, 2016

wouterj Apr 6, 2016

wouterj Apr 6, 2016

wouterj commented Apr 6, 2016

fabpot Apr 10, 2016

linaori commented Apr 11, 2016

fabpot commented Apr 11, 2016

linaori commented Apr 29, 2016

wouterj Apr 29, 2016

linaori commented May 6, 2016

xabbuh May 14, 2016

xabbuh commented May 21, 2016

wouterj commented Jun 11, 2016

linaori commented Jun 12, 2016

Added docs about ArgumentValueResolvers #6438

Added docs about ArgumentValueResolvers #6438

Conversation

linaori commented Apr 6, 2016

wouterj Apr 6, 2016

Choose a reason for hiding this comment

wouterj Apr 6, 2016

Choose a reason for hiding this comment

wouterj commented Apr 6, 2016

fabpot Apr 10, 2016

Choose a reason for hiding this comment

linaori commented Apr 11, 2016

fabpot commented Apr 11, 2016

linaori commented Apr 29, 2016

wouterj Apr 29, 2016

Choose a reason for hiding this comment

linaori commented May 6, 2016

xabbuh May 14, 2016

Choose a reason for hiding this comment

xabbuh commented May 21, 2016

wouterj commented Jun 11, 2016

linaori commented Jun 12, 2016