Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[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
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Revisit PR
  • Loading branch information
wouterj committed Apr 6, 2015
commit 667e141bc79be83fa926228b691031daa630fddf
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ class RequestArgumentResolver implements ArgumentResolverInterface
/**
* {@inheritDoc}
*/
public function accepts(Request $request, \ReflectionParameter $parameter)
public function supports(Request $request, \ReflectionParameter $parameter)
{
$class = $parameter->getClass();

return $class && $class->isInstance($request);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,16 @@ class RequestAttributesArgumentResolver implements ArgumentResolverInterface
/**
* {@inheritDoc}
*/
public function accepts(Request $request, \ReflectionParameter $parameter)
public function supports(Request $request, \ReflectionParameter $parameter)
{
return array_key_exists($parameter->name, $request->attributes->all());
return $request->attributes->has($parameter->name);
}

/**
* {@inheritDoc}
*/
public function resolve(Request $request, \ReflectionParameter $parameter)
{
$attributes = $request->attributes->all();

return $attributes[$parameter->name];
return $request->attributes->get($parameter->name);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,30 @@
use Symfony\Component\HttpFoundation\Request;

/**
* An ArgumentResolverInterface implementation resolves the arguments of
* An ArgumentResolverInterface implementation resolves the arguments of
* controllers.
*
* @author Wouter J <[email protected]>
*/
interface ArgumentResolverInterface
{
/**
* Checks if the current parameter can be resolved by this argument
* Checks if the current parameter can be resolved by this argument
* resolver.
*
* @param Request $request
* @param \ReflectionParameter $parameter
*
* @return Boolean
*/
public function accepts(Request $request, \ReflectionParameter $parameter);
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);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class ArgumentResolverManager
*
* @param ArgumentResolverInterface $resolver
*/
public function addResolver(ArgumentResolverInterface $resolver)
public function add(ArgumentResolverInterface $resolver)
{
$this->resolvers[] = $resolver;
}
Expand All @@ -48,6 +48,10 @@ public function addResolver(ArgumentResolverInterface $resolver)
*/
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) {
Expand All @@ -62,7 +66,7 @@ public function getArguments(Request $request, $controller)

foreach ($parameters as $parameter) {
foreach ($this->resolvers as $argumentResolver) {
if ($argumentResolver->accepts($request, $parameter)) {
if ($argumentResolver->supports($request, $parameter)) {
$arguments[] = $argumentResolver->resolve($request, $parameter);
continue 2;
}
Expand Down
51 changes: 0 additions & 51 deletions src/Symfony/Component/HttpKernel/Controller/ControllerResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -86,57 +86,6 @@ public function getController(Request $request)
return $callable;
}

/**
* {@inheritdoc}
*
* @api
*
* @deprecated Deprecated since Symfony 2.6, will be removed in Symfony 3.0. Use ArgumentResolvers instead
*/
public function getArguments(Request $request, $controller)
{
if (is_array($controller)) {
$r = new \ReflectionMethod($controller[0], $controller[1]);
} elseif (is_object($controller) && !$controller instanceof \Closure) {
$r = new \ReflectionObject($controller);
$r = $r->getMethod('__invoke');
} else {
$r = new \ReflectionFunction($controller);
}

return $this->doGetArguments($request, $controller, $r->getParameters());
}

/**
* @deprecated Deprecated since Symfony 2.6, will be removed in Symfony 3.0. Use ArgumentResolvers instead
*/
protected function doGetArguments(Request $request, $controller, array $parameters)
{
$attributes = $request->attributes->all();
$arguments = array();
foreach ($parameters as $param) {
if (array_key_exists($param->name, $attributes)) {
$arguments[] = $attributes[$param->name];
} elseif ($param->getClass() && $param->getClass()->isInstance($request)) {
$arguments[] = $request;
} elseif ($param->isDefaultValueAvailable()) {
$arguments[] = $param->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 or because there is a non optional argument after this one).', $repr, $param->name));
}
}

return $arguments;
}

/**
* Returns a callable for the given controller.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,4 @@ interface ControllerResolverInterface
* @api
*/
public function getController(Request $request);

/**
* 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 value for argument given is not provided
*
* @api
*/
public function getArguments(Request $request, $controller);
}
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ class RegisterArgumentResolversPass implements CompilerPassInterface
/**
* @var string
*/
protected $managerService;
private $managerService;

/**
* @var string
*/
protected $resolverTag;
private $resolverTag;

public function __construct($managerService = 'argument_resolver.manager', $resolverTag = 'kernel.argument_resolver')
{
Expand All @@ -50,7 +50,7 @@ public function process(ContainerBuilder $container)
$definition = $container->findDefinition($this->managerService);

foreach ($container->findTaggedServiceIds($this->resolverTag) as $id => $resolvers) {
$definition->addMethodCall('addResolver', array(new Reference($id)));
$definition->addMethodCall('add', array(new Reference($id)));
}
}
}
4 changes: 2 additions & 2 deletions src/Symfony/Component/HttpKernel/HttpKernel.php
Original file line number Diff line number Diff line change
Expand Up @@ -304,8 +304,8 @@ protected function getArgumentResolver()
if (null === $this->argumentResolver) {
// to keep BC
$this->argumentResolver = new ArgumentResolverManager();
$this->argumentResolver->addResolver(new ArgumentResolver\RequestArgumentResolver());
$this->argumentResolver->addResolver(new ArgumentResolver\RequestAttributesArgumentResolver());
$this->argumentResolver->add(new ArgumentResolver\RequestArgumentResolver());
$this->argumentResolver->add(new ArgumentResolver\RequestAttributesArgumentResolver());
}

return $this->argumentResolver;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ public function setUp()
$this->manager = new ArgumentResolverManager();
$this->resolver1 = $this->getMock('Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface');
$this->resolver2 = $this->getMock('Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface');
$this->manager->addResolver($this->resolver1);
$this->manager->addResolver($this->resolver2);
$this->manager->add($this->resolver1);
$this->manager->add($this->resolver2);

$this->request = $this->getMock('Symfony\Component\HttpFoundation\Request');
}

public function testGetArgumentsFirstResolverAccepts()
{
$this->resolver1->expects($this->any())->method('accepts')->will($this->returnValue(true));
$this->resolver1->expects($this->any())->method('accepts')->will($this->returnValue(true));
$this->resolver1->expects($this->any())
->method('resolve')
->will($this->returnValue('resolved_value'));
Expand Down