vendor/friendsofsymfony/rest-bundle/FOS/RestBundle/EventListener/ParamFetcherListener.php line 49

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 Symfony\Component\HttpKernel\Event\FilterControllerEvent;
  15. use Symfony\Component\DependencyInjection\ContainerInterface;
  17. /**
  18.  * This listener handles various setup tasks related to the query fetcher.
  19.  *
  20.  * Setting the controller callable on the query fetcher
  21.  * Setting the query fetcher as a request attribute
  22.  *
  23.  * @author Lukas Kahwe Smith <smith@pooteeweet.org>
  24.  */
  25. class ParamFetcherListener
  26. {
  27.     private $container;
  28.     private $setParamsAsAttributes;
  30.     /**
  31.      * Constructor.
  32.      *
  33.      * @param ContainerInterface $container
  34.      * @param bool               $setParamsAsAttributes
  35.      */
  36.     public function __construct(ContainerInterface $container, $setParamsAsAttributes = false)
  37.     {
  38.         $this->container = $container;
  39.         $this->setParamsAsAttributes = $setParamsAsAttributes;
  40.     }
  42.     /**
  43.      * Core controller handler.
  44.      *
  45.      * @param FilterControllerEvent $event
  46.      *
  47.      * @throws \InvalidArgumentException
  48.      */
  49.     public function onKernelController(FilterControllerEvent $event)
  50.     {
  51.         $request = $event->getRequest();
  52.         $paramFetcher = $this->container->get('fos_rest.request.param_fetcher');
  54.         $controller = $event->getController();
  56.         if (is_callable($controller) && method_exists($controller, '__invoke')) {
  57.             $controller = array($controller, '__invoke');
  58.         }
  60.         $paramFetcher->setController($controller);
  61.         $attributeName = $this->getAttributeName($controller);
  62.         $request->attributes->set($attributeName, $paramFetcher);
  64.         if ($this->setParamsAsAttributes) {
  65.             $params = $paramFetcher->all();
  66.             foreach ($params as $name => $param) {
  67.                 if ($request->attributes->has($name) && null !== $request->attributes->get($name)) {
  68.                     $msg = sprintf("ParamFetcher parameter conflicts with a path parameter '$name' for route '%s'", $request->attributes->get('_route'));
  69.                     throw new \InvalidArgumentException($msg);
  70.                 }
  72.                 $request->attributes->set($name, $param);
  73.             }
  74.         }
  75.     }
  77.     /**
  78.      * Determines which attribute the ParamFetcher should be injected as.
  79.      *
  80.      * @param array $controller The controller action as an "array" callable.
  81.      *
  82.      * @return string
  83.      */
  84.     private function getAttributeName(array $controller)
  85.     {
  86.         list($object, $name) = $controller;
  87.         $method = new \ReflectionMethod($object, $name);
  88.         foreach ($method->getParameters() as $param) {
  89.             if ($this->isParamFetcherType($param)) {
  90.                 return $param->getName();
  91.             }
  92.         }
  94.         // If there is no typehint, inject the ParamFetcher using a default name.
  95.         return 'paramFetcher';
  96.     }
  98.     /**
  99.      * Returns true if the given controller parameter is type-hinted as
  100.      * an instance of ParamFetcher.
  101.      *
  102.      * @param \ReflectionParameter $controllerParam A parameter of the controller action.
  103.      *
  104.      * @return bool
  105.      */
  106.     private function isParamFetcherType(\ReflectionParameter $controllerParam)
  107.     {
  108.         $type = $controllerParam->getClass();
  109.         if (null === $type) {
  110.             return false;
  111.         }
  112.         $fetcherInterface = 'FOS\\RestBundle\\Request\\ParamFetcherInterface';
  114.         return $type->implementsInterface($fetcherInterface);
  115.     }
  116. }