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

Open in your IDE?
  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.     /**
  40.      * @param ControllerEvent $event
  41.      */
  42.     public function onKernelController($event)
  43.     {
  44.         $request = $event->getRequest();
  46.         if (!$request->attributes->get(FOSRestBundle::ZONE_ATTRIBUTE, true)) {
  47.             return;
  48.         }
  50.         $controller = $event->getController();
  52.         if (is_callable($controller) && (is_object($controller) || is_string($controller)) && method_exists($controller, '__invoke')) {
  53.             $controller = [$controller, '__invoke'];
  54.         }
  56.         $this->paramFetcher->setController($controller);
  57.         $attributeName = $this->getAttributeName($controller);
  58.         $request->attributes->set($attributeName, $this->paramFetcher);
  60.         if ($this->setParamsAsAttributes) {
  61.             $params = $this->paramFetcher->all();
  62.             foreach ($params as $name => $param) {
  63.                 if ($request->attributes->has($name) && null !== $request->attributes->get($name)) {
  64.                     $msg = sprintf("ParamFetcher parameter conflicts with a path parameter '$name' for route '%s'", $request->attributes->get('_route'));
  66.                     throw new \InvalidArgumentException($msg);
  67.                 }
  69.                 $request->attributes->set($name, $param);
  70.             }
  71.         }
  72.     }
  74.     private function getAttributeName(callable $controller): string
  75.     {
  76.         list($object, $name) = $controller;
  77.         $method = new \ReflectionMethod($object, $name);
  78.         foreach ($method->getParameters() as $param) {
  79.             if ($this->isParamFetcherType($param)) {
  80.                 return $param->getName();
  81.             }
  82.         }
  84.         // If there is no typehint, inject the ParamFetcher using a default name.
  85.         return 'paramFetcher';
  86.     }
  88.     private function isParamFetcherType(\ReflectionParameter $controllerParam): bool
  89.     {
  90.         $type = $controllerParam->getClass();
  91.         if (null === $type) {
  92.             return false;
  93.         }
  95.         return $type->implementsInterface(ParamFetcherInterface::class);
  96.     }
  97. }