-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[WIP] Refactored argument resolving out of the ControllerResolver #11457
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.
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
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 41 additions & 0 deletions
41
src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/RequestArgumentResolver.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\HttpKernel\Controller\ArgumentResolver; | ||
|
|
||
| use Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
|
|
||
| /** | ||
| * Resolves arguments typehinting for the Request object. | ||
| * | ||
| * @author Wouter J <wouter@wouterj.nl> | ||
| */ | ||
| class RequestArgumentResolver implements ArgumentResolverInterface | ||
| { | ||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function supports(Request $request, \ReflectionParameter $parameter) | ||
| { | ||
| $class = $parameter->getClass(); | ||
|
|
||
| return $class && $class->isInstance($request); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function resolve(Request $request, \ReflectionParameter $parameter) | ||
| { | ||
| return $request; | ||
| } | ||
| } |
39 changes: 39 additions & 0 deletions
39
...ny/Component/HttpKernel/Controller/ArgumentResolver/RequestAttributesArgumentResolver.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\HttpKernel\Controller\ArgumentResolver; | ||
|
|
||
| use Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
|
|
||
| /** | ||
| * Resolves arguments which names are equal to the name of a request attribute. | ||
| * | ||
| * @author Wouter J <wouter@wouterj.nl> | ||
| */ | ||
| class RequestAttributesArgumentResolver implements ArgumentResolverInterface | ||
| { | ||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function supports(Request $request, \ReflectionParameter $parameter) | ||
| { | ||
| return $request->attributes->has($parameter->name); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function resolve(Request $request, \ReflectionParameter $parameter) | ||
| { | ||
| return $request->attributes->get($parameter->name); | ||
| } | ||
| } |
44 changes: 44 additions & 0 deletions
44
src/Symfony/Component/HttpKernel/Controller/ArgumentResolverInterface.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\HttpKernel\Controller; | ||
|
|
||
| use Symfony\Component\HttpFoundation\Request; | ||
|
|
||
| /** | ||
| * An ArgumentResolverInterface implementation resolves the arguments of | ||
| * controllers. | ||
| * | ||
| * @author Wouter J <wouter@wouterj.nl> | ||
| */ | ||
| interface ArgumentResolverInterface | ||
| { | ||
| /** | ||
| * Checks if the current parameter can be resolved by this argument | ||
| * resolver. | ||
| * | ||
| * @param Request $request | ||
| * @param \ReflectionParameter $parameter | ||
| * | ||
| * @return bool | ||
| */ | ||
| public function supports(Request $request, \ReflectionParameter $parameter); | ||
|
|
||
| /** | ||
| * Resolves the current parameter into an argument. | ||
| * | ||
| * @param Request $request | ||
| * @param \ReflectionParameter $parameter | ||
| * | ||
| * @return mixed The resolved argument | ||
| */ | ||
| public function resolve(Request $request, \ReflectionParameter $parameter); | ||
| } |
92 changes: 92 additions & 0 deletions
92
src/Symfony/Component/HttpKernel/Controller/ArgumentResolverManager.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\HttpKernel\Controller; | ||
|
|
||
| use Symfony\Component\HttpFoundation\Request; | ||
|
|
||
| /** | ||
| * The ArgumentResolverManager chains over the registered argument resolvers to | ||
| * resolve all controller arguments. | ||
| * | ||
| * @author Wouter J <wouter@wouterj.nl> | ||
| */ | ||
| class ArgumentResolverManager | ||
| { | ||
| /** | ||
| * @var ArgumentResolverInterface[] | ||
| */ | ||
| protected $resolvers = array(); | ||
|
|
||
| /** | ||
| * Adds an argument resolver. | ||
| * | ||
| * @param ArgumentResolverInterface $resolver | ||
| */ | ||
| public function add(ArgumentResolverInterface $resolver) | ||
| { | ||
| $this->resolvers[] = $resolver; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the arguments to pass to the controller. | ||
| * | ||
| * @param Request $request A Request instance | ||
| * @param callable $controller A PHP callable | ||
| * | ||
| * @return array an array of arguments to pass to the controller | ||
| * | ||
| * @throws \RuntimeException When a parameter cannot be resolved | ||
| */ | ||
| public function getArguments(Request $request, $controller) | ||
| { | ||
| if (!is_callable($controller)) { | ||
| throw new \InvalidArgumentException(sprintf('Expected a callable as second parameter, got "%s".', is_object($controller) ? get_class($controller) : gettype($controller))); | ||
| } | ||
|
|
||
| if (is_array($controller)) { | ||
| $controllerReflection = new \ReflectionMethod($controller[0], $controller[1]); | ||
| } elseif (is_object($controller) && !$controller instanceof \Closure) { | ||
| $controllerReflection = new \ReflectionObject($controller); | ||
| $controllerReflection = $controllerReflection->getMethod('__invoke'); | ||
| } else { | ||
| $controllerReflection = new \ReflectionFunction($controller); | ||
| } | ||
|
|
||
| $parameters = $controllerReflection->getParameters(); | ||
| $arguments = array(); | ||
|
|
||
| foreach ($parameters as $parameter) { | ||
| foreach ($this->resolvers as $argumentResolver) { | ||
| if ($argumentResolver->supports($request, $parameter)) { | ||
| $arguments[] = $argumentResolver->resolve($request, $parameter); | ||
| continue 2; | ||
| } | ||
| } | ||
|
|
||
| if ($parameter->isDefaultValueAvailable()) { | ||
| $arguments[] = $parameter->getDefaultValue(); | ||
| } else { | ||
| if (is_array($controller)) { | ||
| $repr = sprintf('%s::%s()', get_class($controller[0]), $controller[1]); | ||
| } elseif (is_object($controller)) { | ||
| $repr = get_class($controller); | ||
| } else { | ||
| $repr = $controller; | ||
| } | ||
|
|
||
| throw new \RuntimeException(sprintf('Controller "%s" requires that you provide a value for the "$%s" argument (because there is no default value and none of the argument resolvers could resolve its value).', $repr, $parameter->name)); | ||
| } | ||
| } | ||
|
|
||
| return $arguments; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should be private