vendor/symfony/http-kernel/Controller/ArgumentResolver.php line 58

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpKernel\Controller;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpKernel\Controller\ArgumentResolver\DefaultValueResolver;
  16. use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestAttributeValueResolver;
  17. use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestValueResolver;
  18. use Symfony\Component\HttpKernel\Controller\ArgumentResolver\SessionValueResolver;
  19. use Symfony\Component\HttpKernel\Controller\ArgumentResolver\VariadicValueResolver;
  20. use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactory;
  21. use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactoryInterface;
  23. /**
  24.  * Responsible for resolving the arguments passed to an action.
  25.  *
  26.  * @author Iltar van der Berg <kjarli@gmail.com>
  27.  */
  28. final class ArgumentResolver implements ArgumentResolverInterface
  29. {
  30.     private $argumentMetadataFactory;
  31.     private $argumentValueResolvers;
  33.     /**
  34.      * @param iterable<mixed, ArgumentValueResolverInterface> $argumentValueResolvers
  35.      */
  36.     public function __construct(ArgumentMetadataFactoryInterface $argumentMetadataFactory = null, iterable $argumentValueResolvers = [])
  37.     {
  38.         $this->argumentMetadataFactory = $argumentMetadataFactory ?? new ArgumentMetadataFactory();
  39.         $this->argumentValueResolvers = $argumentValueResolvers ?: self::getDefaultArgumentValueResolvers();
  40.     }
  42.     /**
  43.      * {@inheritdoc}
  44.      */
  45.     public function getArguments(Request $request, callable $controller): array
  46.     {
  47.         $arguments = [];
  49.         foreach ($this->argumentMetadataFactory->createArgumentMetadata($controller) as $metadata) {
  50.             foreach ($this->argumentValueResolvers as $resolver) {
  51.                 if (!$resolver->supports($request, $metadata)) {
  52.                     continue;
  53.                 }
  55.                 $resolved = $resolver->resolve($request, $metadata);
  57.                 $atLeastOne = false;
  58.                 foreach ($resolved as $append) {
  59.                     $atLeastOne = true;
  60.                     $arguments[] = $append;
  61.                 }
  63.                 if (!$atLeastOne) {
  64.                     throw new \InvalidArgumentException(sprintf('"%s::resolve()" must yield at least one value.', get_debug_type($resolver)));
  65.                 }
  67.                 // continue to the next controller argument
  68.                 continue 2;
  69.             }
  71.             $representative = $controller;
  73.             if (\is_array($representative)) {
  74.                 $representative = sprintf('%s::%s()', \get_class($representative[0]), $representative[1]);
  75.             } elseif (\is_object($representative)) {
  76.                 $representative = \get_class($representative);
  77.             }
  79.             throw new \RuntimeException(sprintf('Controller "%s" requires that you provide a value for the "$%s" argument. Either the argument is nullable and no null value has been provided, no default value has been provided or because there is a non optional argument after this one.', $representative, $metadata->getName()));
  80.         }
  82.         return $arguments;
  83.     }
  85.     /**
  86.      * @return iterable<int, ArgumentValueResolverInterface>
  87.      */
  88.     public static function getDefaultArgumentValueResolvers(): iterable
  89.     {
  90.         return [
  91.             new RequestAttributeValueResolver(),
  92.             new RequestValueResolver(),
  93.             new SessionValueResolver(),
  94.             new DefaultValueResolver(),
  95.             new VariadicValueResolver(),
  96.         ];
  97.     }
  98. }