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

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\ConfigurationAnnotation;
  17. use Sensio\Bundle\FrameworkExtraBundle\Configuration\ConfigurationInterface;
  18. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  19. use Symfony\Component\HttpKernel\Event\KernelEvent;
  20. use Symfony\Component\HttpKernel\KernelEvents;
  22. /**
  23.  * The ControllerListener class parses annotation blocks located in
  24.  * controller classes.
  25.  *
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  */
  28. class ControllerListener implements EventSubscriberInterface
  29. {
  30.     /**
  31.      * @var Reader
  32.      */
  33.     private $reader;
  35.     public function __construct(Reader $reader)
  36.     {
  37.         $this->reader = $reader;
  38.     }
  40.     /**
  41.      * Modifies the Request object to apply configuration information found in
  42.      * controllers annotations like the template to render or HTTP caching
  43.      * configuration.
  44.      */
  45.     public function onKernelController(KernelEvent $event)
  46.     {
  47.         $controller = $event->getController();
  49.         if (!\is_array($controller) && method_exists($controller, '__invoke')) {
  50.             $controller = [$controller, '__invoke'];
  51.         }
  53.         if (!\is_array($controller)) {
  54.             return;
  55.         }
  57.         $className = $this->getRealClass(\get_class($controller[0]));
  58.         $object = new \ReflectionClass($className);
  59.         $method = $object->getMethod($controller[1]);
  61.         $classConfigurations = $this->getConfigurations($this->reader->getClassAnnotations($object));
  62.         $methodConfigurations = $this->getConfigurations($this->reader->getMethodAnnotations($method));
  64.         if (80000 <= \PHP_VERSION_ID) {
  65.             $classAttributes = array_map(
  66.                 function (\ReflectionAttribute $attribute) {
  67.                     return $attribute->newInstance();
  68.                 },
  69.                 $object->getAttributes(ConfigurationAnnotation::class, \ReflectionAttribute::IS_INSTANCEOF)
  70.             );
  71.             $classConfigurations = array_merge($classConfigurations, $this->getConfigurations($classAttributes));
  73.             $methodAttributes = array_map(
  74.                 function (\ReflectionAttribute $attribute) {
  75.                     return $attribute->newInstance();
  76.                 },
  77.                 $method->getAttributes(ConfigurationAnnotation::class, \ReflectionAttribute::IS_INSTANCEOF)
  78.             );
  79.             $methodConfigurations = array_merge($methodConfigurations, $this->getConfigurations($methodAttributes));
  80.         }
  82.         $configurations = [];
  83.         foreach (array_merge(array_keys($classConfigurations), array_keys($methodConfigurations)) as $key) {
  84.             if (!\array_key_exists($key, $classConfigurations)) {
  85.                 $configurations[$key] = $methodConfigurations[$key];
  86.             } elseif (!\array_key_exists($key, $methodConfigurations)) {
  87.                 $configurations[$key] = $classConfigurations[$key];
  88.             } else {
  89.                 if (\is_array($classConfigurations[$key])) {
  90.                     if (!\is_array($methodConfigurations[$key])) {
  91.                         throw new \UnexpectedValueException('Configurations should both be an array or both not be an array.');
  92.                     }
  93.                     $configurations[$key] = array_merge($classConfigurations[$key], $methodConfigurations[$key]);
  94.                 } else {
  95.                     // method configuration overrides class configuration
  96.                     $configurations[$key] = $methodConfigurations[$key];
  97.                 }
  98.             }
  99.         }
  101.         $request = $event->getRequest();
  102.         foreach ($configurations as $key => $attributes) {
  103.             $request->attributes->set($key, $attributes);
  104.         }
  105.     }
  107.     private function getConfigurations(array $annotations)
  108.     {
  109.         $configurations = [];
  110.         foreach ($annotations as $configuration) {
  111.             if ($configuration instanceof ConfigurationInterface) {
  112.                 if ($configuration->allowArray()) {
  113.                     $configurations['_'.$configuration->getAliasName()][] = $configuration;
  114.                 } elseif (!isset($configurations['_'.$configuration->getAliasName()])) {
  115.                     $configurations['_'.$configuration->getAliasName()] = $configuration;
  116.                 } else {
  117.                     throw new \LogicException(sprintf('Multiple "%s" annotations are not allowed.', $configuration->getAliasName()));
  118.                 }
  119.             }
  120.         }
  122.         return $configurations;
  123.     }
  125.     /**
  126.      * @return array
  127.      */
  128.     public static function getSubscribedEvents()
  129.     {
  130.         return [
  131.             KernelEvents::CONTROLLER => 'onKernelController',
  132.         ];
  133.     }
  135.     private static function getRealClass(string $class): string
  136.     {
  137.         if (class_exists(Proxy::class)) {
  138.             if (false === $pos = strrpos($class, '\\'.Proxy::MARKER.'\\')) {
  139.                 return $class;
  140.             }
  142.             return substr($class, $pos + Proxy::MARKER_LENGTH + 2);
  143.         }
  145.         return $class;
  146.     }
  147. }