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

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\FilterControllerEvent;
  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.     /**
  34.      * Constructor.
  35.      *
  36.      * @param ParamFetcherInterface $paramFetcher
  37.      * @param bool                  $setParamsAsAttributes
  38.      */
  39.     public function __construct(ParamFetcherInterface $paramFetcher, $setParamsAsAttributes = false)
  40.     {
  41.         $this->paramFetcher = $paramFetcher;
  42.         $this->setParamsAsAttributes = $setParamsAsAttributes;
  43.     }
  45.     /**
  46.      * Core controller handler.
  47.      *
  48.      * @param FilterControllerEvent $event
  49.      *
  50.      * @throws \InvalidArgumentException
  51.      */
  52.     public function onKernelController(FilterControllerEvent $event)
  53.     {
  54.         $request = $event->getRequest();
  56.         if (!$request->attributes->get(FOSRestBundle::ZONE_ATTRIBUTE, true)) {
  57.             return;
  58.         }
  60.         $controller = $event->getController();
  62.         if (is_callable($controller) && method_exists($controller, '__invoke')) {
  63.             $controller = [$controller, '__invoke'];
  64.         }
  66.         $this->paramFetcher->setController($controller);
  67.         $attributeName = $this->getAttributeName($controller);
  68.         $request->attributes->set($attributeName, $this->paramFetcher);
  70.         if ($this->setParamsAsAttributes) {
  71.             $params = $this->paramFetcher->all();
  72.             foreach ($params as $name => $param) {
  73.                 if ($request->attributes->has($name) && null !== $request->attributes->get($name)) {
  74.                     $msg = sprintf("ParamFetcher parameter conflicts with a path parameter '$name' for route '%s'", $request->attributes->get('_route'));
  76.                     throw new \InvalidArgumentException($msg);
  77.                 }
  79.                 $request->attributes->set($name, $param);
  80.             }
  81.         }
  82.     }
  84.     /**
  85.      * Determines which attribute the ParamFetcher should be injected as.
  86.      *
  87.      * @param callable $controller The controller action as an "array" callable
  88.      *
  89.      * @return string
  90.      */
  91.     private function getAttributeName(callable $controller)
  92.     {
  93.         list($object, $name) = $controller;
  94.         $method = new \ReflectionMethod($object, $name);
  95.         foreach ($method->getParameters() as $param) {
  96.             if ($this->isParamFetcherType($param)) {
  97.                 return $param->getName();
  98.             }
  99.         }
  101.         // If there is no typehint, inject the ParamFetcher using a default name.
  102.         return 'paramFetcher';
  103.     }
  105.     /**
  106.      * Returns true if the given controller parameter is type-hinted as
  107.      * an instance of ParamFetcher.
  108.      *
  109.      * @param \ReflectionParameter $controllerParam A parameter of the controller action
  110.      *
  111.      * @return bool
  112.      */
  113.     private function isParamFetcherType(\ReflectionParameter $controllerParam)
  114.     {
  115.         $type = $controllerParam->getClass();
  116.         if (null === $type) {
  117.             return false;
  118.         }
  120.         return $type->implementsInterface(ParamFetcherInterface::class);
  121.     }
  122. }