Documented the new kernel.controller_arguments event #6434
Conversation
javiereguiluz
commented
Apr 5, 2016
| Q | A |
|---|---|
| Doc fix? | no |
| New docs? | yes |
| Applies to | master (3.1+) |
| Fixed tickets | symfony/symfony#18440 |
This PR was merged into the 3.1-dev branch. Discussion ---------- Add the kernel.controller_arguments event | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #18362 | License | MIT | Doc PR | symfony/symfony-docs#6434 I'm not sure this can be integrated in 3.1 due to the feature freeze, but it would be great if it is, as it is a must-have to be able to make the ``@Security`` annotation compatible with the new argument resolver system (as we need to be able to run the security assertion after the resolving). I made the arguments mutable here for consistency with ``kernel.controller`` (and @fabpot replied LGTM in the RFC when I suggested it). Commits ------- af02e2a Add the kernel.controller_arguments event
| The ``kernel.controller_arguments`` event was introduced in Symfony 3.1. | ||
|
|
||
| Once controller arguments have been resolved by Symfony, the ``kernel.controller_arguments`` | ||
| event is triggered. This allows to modify or replace the arguments to fit your |
There was a problem hiding this comment.
it now also allows to replace the controller
There was a problem hiding this comment.
I've reworded this. Thanks!
This PR was merged into the 3.1-dev branch. Discussion ---------- Add the kernel.controller_arguments event | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #18362 | License | MIT | Doc PR | symfony/symfony-docs#6434 I'm not sure this can be integrated in 3.1 due to the feature freeze, but it would be great if it is, as it is a must-have to be able to make the ``@Security`` annotation compatible with the new argument resolver system (as we need to be able to run the security assertion after the resolving). I made the arguments mutable here for consistency with ``kernel.controller`` (and @fabpot replied LGTM in the RFC when I suggested it). Commits ------- af02e2a Add the kernel.controller_arguments event
|
|
||
| This event can be an entry point used to modify the arguments of the controller | ||
| once they have been resolved by Symfony:: | ||
|
|
There was a problem hiding this comment.
namespace is missing, otherwise its not very clear where to put this method IMO
There was a problem hiding this comment.
you can put it where you want (as long as you tell Symfony that this method is a listener for this event) .
And the current proposal is consistent with other snippets in the page
|
I've made the requested changes. Another PR ready to be merged. Thanks! |
|
|
||
| **Event Class**: :class:`Symfony\\Component\\HttpKernel\\Event\\FilterControllerArgumentsEvent` | ||
|
|
||
| This event can be an entry point used to modify the arguments of the controller |
|
👍 |
|
After the last fixes, this is ready to be merged. Thanks! |
|
This is probably the most confusing feature of Symfony 3.1 and that's already visible in this PR: Replacing arguments is not the main reason for this new event. This new event is triggered after arguments are resolved, so some logic can be executed based on these arguments. For instance, the If you want to replace arguments, writing a custom ArgumentValueResolver is the way to go (after that PR is merged, we should definitely reference it in this section). |
|
A use case to replace arguments is when you want to replace both the controller and the argument, after resolution of the original arguments (because your new controller is a closure wrapping the original controller). This was the use case brought by @fabpot (for a Blackfire use case IIRC) to allow replacing the controller in this event as well. |
|
Status: Needs Work |
|
@wouterj I can't finish this PR. If you or any other volunteer can finish it, please take over this PR. Thanks. |
|
Closing it because I can't finish it. I've opened an issue related to this: #6854. |