vendor/friendsofsymfony/rest-bundle/EventListener/ParamFetcherListener.php line 39

  1. <?php
  3. /*
  4.  * This file is part of the FOSRestBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.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 FOS\RestBundle\EventListener;
  14. use FOS\RestBundle\FOSRestBundle;
  15. use FOS\RestBundle\Request\ParamFetcherInterface;
  16. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  18. /**
  19.  * This listener handles various setup tasks related to the query fetcher.
  20.  *
  21.  * Setting the controller callable on the query fetcher
  22.  * Setting the query fetcher as a request attribute
  23.  *
  24.  * @author Lukas Kahwe Smith <smith@pooteeweet.org>
  25.  *
  26.  * @internal
  27.  */
  28. class ParamFetcherListener
  29. {
  30.     private $paramFetcher;
  31.     private $setParamsAsAttributes;
  33.     public function __construct(ParamFetcherInterface $paramFetcher, bool $setParamsAsAttributes = false)
  34.     {
  35.         $this->paramFetcher = $paramFetcher;
  36.         $this->setParamsAsAttributes = $setParamsAsAttributes;
  37.     }
  39.     public function onKernelController(ControllerEvent $event): void
  40.     {
  41.         $request = $event->getRequest();
  43.         if (!$request->attributes->get(FOSRestBundle::ZONE_ATTRIBUTE, true)) {
  44.             return;
  45.         }
  47.         $controller = $event->getController();
  49.         if (is_callable($controller) && (is_object($controller) || is_string($controller)) && method_exists($controller, '__invoke')) {
  50.             $controller = [$controller, '__invoke'];
  51.         }
  53.         $this->paramFetcher->setController($controller);
  54.         $attributeName = $this->getAttributeName($controller);
  55.         $request->attributes->set($attributeName, $this->paramFetcher);
  57.         if ($this->setParamsAsAttributes) {
  58.             $params = $this->paramFetcher->all();
  59.             foreach ($params as $name => $param) {
  60.                 if ($request->attributes->has($name) && null !== $request->attributes->get($name)) {
  61.                     $msg = sprintf("ParamFetcher parameter conflicts with a path parameter '$name' for route '%s'", $request->attributes->get('_route'));
  63.                     throw new \InvalidArgumentException($msg);
  64.                 }
  66.                 $request->attributes->set($name, $param);
  67.             }
  68.         }
  69.     }
  71.     private function getAttributeName(callable $controller): string
  72.     {
  73.         list($object, $name) = $controller;
  74.         $method = new \ReflectionMethod($object, $name);
  75.         foreach ($method->getParameters() as $param) {
  76.             if ($this->isParamFetcherType($param)) {
  77.                 return $param->getName();
  78.             }
  79.         }
  81.         // If there is no typehint, inject the ParamFetcher using a default name.
  82.         return 'paramFetcher';
  83.     }
  85.     private function isParamFetcherType(\ReflectionParameter $controllerParam): bool
  86.     {
  87.         $type = $controllerParam->getType();
  88.         foreach ($type instanceof \ReflectionUnionType ? $type->getTypes() : [$type] as $type) {
  89.             if (null === $type || $type->isBuiltin() || !$type instanceof \ReflectionNamedType) {
  90.                 continue;
  91.             }
  93.             $class = new \ReflectionClass($type->getName());
  95.             if ($class->implementsInterface(ParamFetcherInterface::class)) {
  96.                 return true;
  97.             }
  98.         }
  100.         return false;
  101.     }
  102. }