ArgumentResolver.php 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\HttpKernel\Controller;
  11. use Psr\Container\ContainerInterface;
  12. use Symfony\Component\HttpFoundation\Request;
  13. use Symfony\Component\HttpKernel\Attribute\ValueResolver;
  14. use Symfony\Component\HttpKernel\Controller\ArgumentResolver\DefaultValueResolver;
  15. use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestAttributeValueResolver;
  16. use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestValueResolver;
  17. use Symfony\Component\HttpKernel\Controller\ArgumentResolver\SessionValueResolver;
  18. use Symfony\Component\HttpKernel\Controller\ArgumentResolver\VariadicValueResolver;
  19. use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactory;
  20. use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactoryInterface;
  21. use Symfony\Component\HttpKernel\Exception\NearMissValueResolverException;
  22. use Symfony\Component\HttpKernel\Exception\ResolverNotFoundException;
  23. use Symfony\Contracts\Service\ServiceProviderInterface;
  24. /**
  25. * Responsible for resolving the arguments passed to an action.
  26. *
  27. * @author Iltar van der Berg <kjarli@gmail.com>
  28. */
  29. final class ArgumentResolver implements ArgumentResolverInterface
  30. {
  31. private ArgumentMetadataFactoryInterface $argumentMetadataFactory;
  32. private iterable $argumentValueResolvers;
  33. private ?ContainerInterface $namedResolvers;
  34. /**
  35. * @param iterable<mixed, ValueResolverInterface> $argumentValueResolvers
  36. */
  37. public function __construct(?ArgumentMetadataFactoryInterface $argumentMetadataFactory = null, iterable $argumentValueResolvers = [], ?ContainerInterface $namedResolvers = null)
  38. {
  39. $this->argumentMetadataFactory = $argumentMetadataFactory ?? new ArgumentMetadataFactory();
  40. $this->argumentValueResolvers = $argumentValueResolvers ?: self::getDefaultArgumentValueResolvers();
  41. $this->namedResolvers = $namedResolvers;
  42. }
  43. public function getArguments(Request $request, callable $controller, ?\ReflectionFunctionAbstract $reflector = null): array
  44. {
  45. $arguments = [];
  46. foreach ($this->argumentMetadataFactory->createArgumentMetadata($controller, $reflector) as $metadata) {
  47. $argumentValueResolvers = $this->argumentValueResolvers;
  48. $disabledResolvers = [];
  49. if ($this->namedResolvers && $attributes = $metadata->getAttributesOfType(ValueResolver::class, $metadata::IS_INSTANCEOF)) {
  50. $resolverName = null;
  51. foreach ($attributes as $attribute) {
  52. if ($attribute->disabled) {
  53. $disabledResolvers[$attribute->resolver] = true;
  54. } elseif ($resolverName) {
  55. throw new \LogicException(sprintf('You can only pin one resolver per argument, but argument "$%s" of "%s()" has more.', $metadata->getName(), $metadata->getControllerName()));
  56. } else {
  57. $resolverName = $attribute->resolver;
  58. }
  59. }
  60. if ($resolverName) {
  61. if (!$this->namedResolvers->has($resolverName)) {
  62. throw new ResolverNotFoundException($resolverName, $this->namedResolvers instanceof ServiceProviderInterface ? array_keys($this->namedResolvers->getProvidedServices()) : []);
  63. }
  64. $argumentValueResolvers = [
  65. $this->namedResolvers->get($resolverName),
  66. new RequestAttributeValueResolver(),
  67. new DefaultValueResolver(),
  68. ];
  69. }
  70. }
  71. $valueResolverExceptions = [];
  72. foreach ($argumentValueResolvers as $name => $resolver) {
  73. if (isset($disabledResolvers[\is_int($name) ? $resolver::class : $name])) {
  74. continue;
  75. }
  76. try {
  77. $count = 0;
  78. foreach ($resolver->resolve($request, $metadata) as $argument) {
  79. ++$count;
  80. $arguments[] = $argument;
  81. }
  82. } catch (NearMissValueResolverException $e) {
  83. $valueResolverExceptions[] = $e;
  84. }
  85. if (1 < $count && !$metadata->isVariadic()) {
  86. throw new \InvalidArgumentException(sprintf('"%s::resolve()" must yield at most one value for non-variadic arguments.', get_debug_type($resolver)));
  87. }
  88. if ($count) {
  89. // continue to the next controller argument
  90. continue 2;
  91. }
  92. }
  93. $reasons = array_map(static fn (NearMissValueResolverException $e) => $e->getMessage(), $valueResolverExceptions);
  94. if (!$reasons) {
  95. $reasons[] = 'Either the argument is nullable and no null value has been provided, no default value has been provided or there is a non-optional argument after this one.';
  96. }
  97. $reasonCounter = 1;
  98. if (\count($reasons) > 1) {
  99. foreach ($reasons as $i => $reason) {
  100. $reasons[$i] = $reasonCounter.') '.$reason;
  101. ++$reasonCounter;
  102. }
  103. }
  104. throw new \RuntimeException(sprintf('Controller "%s" requires the "$%s" argument that could not be resolved. '.($reasonCounter > 1 ? 'Possible reasons: ' : '').'%s', $metadata->getControllerName(), $metadata->getName(), implode(' ', $reasons)));
  105. }
  106. return $arguments;
  107. }
  108. /**
  109. * @return iterable<int, ValueResolverInterface>
  110. */
  111. public static function getDefaultArgumentValueResolvers(): iterable
  112. {
  113. return [
  114. new RequestAttributeValueResolver(),
  115. new RequestValueResolver(),
  116. new SessionValueResolver(),
  117. new DefaultValueResolver(),
  118. new VariadicValueResolver(),
  119. ];
  120. }
  121. }