vendor/sensio/framework-extra-bundle/src/EventListener/ControllerListener.php line 44

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 Doctrine\Common\Annotations\Reader;
  15. use Doctrine\Persistence\Proxy;
  16. use Sensio\Bundle\FrameworkExtraBundle\Configuration\ConfigurationInterface;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. use Symfony\Component\HttpKernel\Event\KernelEvent;
  19. use Symfony\Component\HttpKernel\KernelEvents;
  21. /**
  22.  * The ControllerListener class parses annotation blocks located in
  23.  * controller classes.
  24.  *
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  */
  27. class ControllerListener implements EventSubscriberInterface
  28. {
  29.     /**
  30.      * @var Reader
  31.      */
  32.     private $reader;
  34.     public function __construct(Reader $reader)
  35.     {
  36.         $this->reader = $reader;
  37.     }
  39.     /**
  40.      * Modifies the Request object to apply configuration information found in
  41.      * controllers annotations like the template to render or HTTP caching
  42.      * configuration.
  43.      */
  44.     public function onKernelController(KernelEvent $event)
  45.     {
  46.         $controller = $event->getController();
  48.         if (!\is_array($controller) && method_exists($controller, '__invoke')) {
  49.             $controller = [$controller, '__invoke'];
  50.         }
  52.         if (!\is_array($controller)) {
  53.             return;
  54.         }
  56.         $className = $this->getRealClass(\get_class($controller[0]));
  57.         $object = new \ReflectionClass($className);
  58.         $method = $object->getMethod($controller[1]);
  60.         $classConfigurations = $this->getConfigurations($this->reader->getClassAnnotations($object));
  61.         $methodConfigurations = $this->getConfigurations($this->reader->getMethodAnnotations($method));
  63.         $configurations = [];
  64.         foreach (array_merge(array_keys($classConfigurations), array_keys($methodConfigurations)) as $key) {
  65.             if (!\array_key_exists($key, $classConfigurations)) {
  66.                 $configurations[$key] = $methodConfigurations[$key];
  67.             } elseif (!\array_key_exists($key, $methodConfigurations)) {
  68.                 $configurations[$key] = $classConfigurations[$key];
  69.             } else {
  70.                 if (\is_array($classConfigurations[$key])) {
  71.                     if (!\is_array($methodConfigurations[$key])) {
  72.                         throw new \UnexpectedValueException('Configurations should both be an array or both not be an array.');
  73.                     }
  74.                     $configurations[$key] = array_merge($classConfigurations[$key], $methodConfigurations[$key]);
  75.                 } else {
  76.                     // method configuration overrides class configuration
  77.                     $configurations[$key] = $methodConfigurations[$key];
  78.                 }
  79.             }
  80.         }
  82.         $request = $event->getRequest();
  83.         foreach ($configurations as $key => $attributes) {
  84.             $request->attributes->set($key, $attributes);
  85.         }
  86.     }
  88.     private function getConfigurations(array $annotations)
  89.     {
  90.         $configurations = [];
  91.         foreach ($annotations as $configuration) {
  92.             if ($configuration instanceof ConfigurationInterface) {
  93.                 if ($configuration->allowArray()) {
  94.                     $configurations['_'.$configuration->getAliasName()][] = $configuration;
  95.                 } elseif (!isset($configurations['_'.$configuration->getAliasName()])) {
  96.                     $configurations['_'.$configuration->getAliasName()] = $configuration;
  97.                 } else {
  98.                     throw new \LogicException(sprintf('Multiple "%s" annotations are not allowed.', $configuration->getAliasName()));
  99.                 }
  100.             }
  101.         }
  103.         return $configurations;
  104.     }
  106.     /**
  107.      * {@inheritdoc}
  108.      */
  109.     public static function getSubscribedEvents()
  110.     {
  111.         return [
  112.             KernelEvents::CONTROLLER => 'onKernelController',
  113.         ];
  114.     }
  116.     private static function getRealClass(string $class): string
  117.     {
  118.         if (class_exists(Proxy::class)) {
  119.             if (false === $pos = strrpos($class, '\\'.Proxy::MARKER.'\\')) {
  120.                 return $class;
  121.             }
  123.             return substr($class, $pos + Proxy::MARKER_LENGTH + 2);
  124.         }
  126.         return $class;
  127.     }
  128. }