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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.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 Sensio\Bundle\FrameworkExtraBundle\EventListener;
  14. use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
  15. use Sensio\Bundle\FrameworkExtraBundle\Request\ParamConverter\ParamConverterManager;
  16. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\HttpKernel\Event\KernelEvent;
  19. use Symfony\Component\HttpKernel\KernelEvents;
  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.     private $manager;
  33.     private $autoConvert;
  35.     /**
  36.      * @var bool
  37.      */
  38.     private $isParameterTypeSupported;
  40.     /**
  41.      * @param bool $autoConvert Auto convert non-configured objects
  42.      */
  43.     public function __construct(ParamConverterManager $manager, $autoConvert = true)
  44.     {
  45.         $this->manager = $manager;
  46.         $this->autoConvert = $autoConvert;
  47.         $this->isParameterTypeSupported = method_exists('ReflectionParameter', 'getType');
  48.     }
  50.     /**
  51.      * Modifies the ParamConverterManager instance.
  52.      */
  53.     public function onKernelController(KernelEvent $event)
  54.     {
  55.         $controller = $event->getController();
  56.         $request = $event->getRequest();
  57.         $configurations = [];
  59.         if ($configuration = $request->attributes->get('_converters')) {
  60.             foreach (\is_array($configuration) ? $configuration : [$configuration] as $configuration) {
  61.                 $configurations[$configuration->getName()] = $configuration;
  62.             }
  63.         }
  65.         if (\is_array($controller)) {
  66.             $r = new \ReflectionMethod($controller[0], $controller[1]);
  67.         } elseif (\is_object($controller) && \is_callable([$controller, '__invoke'])) {
  68.             $r = new \ReflectionMethod($controller, '__invoke');
  69.         } else {
  70.             $r = new \ReflectionFunction($controller);
  71.         }
  73.         // automatically apply conversion for non-configured objects
  74.         if ($this->autoConvert) {
  75.             $configurations = $this->autoConfigure($r, $request, $configurations);
  76.         }
  78.         $this->manager->apply($request, $configurations);
  79.     }
  81.     private function autoConfigure(\ReflectionFunctionAbstract $r, Request $request, $configurations)
  82.     {
  83.         foreach ($r->getParameters() as $param) {
  84.             if ($param->getClass() && $param->getClass()->isInstance($request)) {
  85.                 continue;
  86.             }
  88.             $name = $param->getName();
  89.             $class = $param->getClass();
  90.             $hasType = $this->isParameterTypeSupported && $param->hasType();
  92.             if ($class || $hasType) {
  93.                 if (!isset($configurations[$name])) {
  94.                     $configuration = new ParamConverter([]);
  95.                     $configuration->setName($name);
  97.                     $configurations[$name] = $configuration;
  98.                 }
  100.                 if ($class && null === $configurations[$name]->getClass()) {
  101.                     $configurations[$name]->setClass($class->getName());
  102.                 }
  103.             }
  105.             if (isset($configurations[$name])) {
  106.                 $configurations[$name]->setIsOptional($param->isOptional() || $param->isDefaultValueAvailable() || $hasType && $param->getType()->allowsNull());
  107.             }
  108.         }
  110.         return $configurations;
  111.     }
  113.     /**
  114.      * {@inheritdoc}
  115.      */
  116.     public static function getSubscribedEvents()
  117.     {
  118.         return [
  119.             KernelEvents::CONTROLLER => 'onKernelController',
  120.         ];
  121.     }
  122. }