vendor/sensio/framework-extra-bundle/EventListener/ParamConverterListener.php line 58

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony framework.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sensio\Bundle\FrameworkExtraBundle\EventListener;
  14. use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
  15. use Sensio\Bundle\FrameworkExtraBundle\Request\ParamConverter\ParamConverterManager;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
  18. use Symfony\Component\HttpKernel\KernelEvents;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  21. /**
  22.  * The ParamConverterListener handles the ParamConverter annotation.
  23.  *
  24.  * @author Fabien Potencier <fabien@symfony.com>
  25.  */
  26. class ParamConverterListener implements EventSubscriberInterface
  27. {
  28.     /**
  29.      * @var ParamConverterManager
  30.      */
  31.     protected $manager;
  33.     protected $autoConvert;
  35.     /**
  36.      * @var bool
  37.      */
  38.     private $isParameterTypeSupported;
  40.     /**
  41.      * Constructor.
  42.      *
  43.      * @param ParamConverterManager $manager     A ParamConverterManager instance
  44.      * @param bool                  $autoConvert Auto convert non-configured objects
  45.      */
  46.     public function __construct(ParamConverterManager $manager, $autoConvert = true)
  47.     {
  48.         $this->manager = $manager;
  49.         $this->autoConvert = $autoConvert;
  50.         $this->isParameterTypeSupported = method_exists('ReflectionParameter', 'getType');
  51.     }
  53.     /**
  54.      * Modifies the ParamConverterManager instance.
  55.      *
  56.      * @param FilterControllerEvent $event A FilterControllerEvent instance
  57.      */
  58.     public function onKernelController(FilterControllerEvent $event)
  59.     {
  60.         $controller = $event->getController();
  61.         $request = $event->getRequest();
  62.         $configurations = array();
  64.         if ($configuration = $request->attributes->get('_converters')) {
  65.             foreach (is_array($configuration) ? $configuration : array($configuration) as $configuration) {
  66.                 $configurations[$configuration->getName()] = $configuration;
  67.             }
  68.         }
  70.         if (is_array($controller)) {
  71.             $r = new \ReflectionMethod($controller[0], $controller[1]);
  72.         } elseif (is_object($controller) && is_callable($controller, '__invoke')) {
  73.             $r = new \ReflectionMethod($controller, '__invoke');
  74.         } else {
  75.             $r = new \ReflectionFunction($controller);
  76.         }
  78.         // automatically apply conversion for non-configured objects
  79.         if ($this->autoConvert) {
  80.             $configurations = $this->autoConfigure($r, $request, $configurations);
  81.         }
  83.         $this->manager->apply($request, $configurations);
  84.     }
  86.     private function autoConfigure(\ReflectionFunctionAbstract $r, Request $request, $configurations)
  87.     {
  88.         foreach ($r->getParameters() as $param) {
  89.             if ($param->getClass() && $param->getClass()->isInstance($request)) {
  90.                 continue;
  91.             }
  93.             $name = $param->getName();
  94.             $class = $param->getClass();
  95.             $hasType = $this->isParameterTypeSupported && $param->hasType();
  97.             if ($class || $hasType) {
  98.                 if (!isset($configurations[$name])) {
  99.                     $configuration = new ParamConverter(array());
  100.                     $configuration->setName($name);
  102.                     $configurations[$name] = $configuration;
  103.                 }
  105.                 if ($class && null === $configurations[$name]->getClass()) {
  106.                     $configurations[$name]->setClass($class->getName());
  107.                 }
  108.             }
  110.             if (isset($configurations[$name])) {
  111.                 $configurations[$name]->setIsOptional($param->isOptional() || $param->isDefaultValueAvailable() || $hasType && $param->getType()->allowsNull());
  112.             }
  113.         }
  115.         return $configurations;
  116.     }
  118.     /**
  119.      * Get subscribed events.
  120.      *
  121.      * @return array Subscribed events
  122.      */
  123.     public static function getSubscribedEvents()
  124.     {
  125.         return array(
  126.             KernelEvents::CONTROLLER => 'onKernelController',
  127.         );
  128.     }
  129. }