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

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 Doctrine\Common\Annotations\Reader;
  15. use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
  16. use Symfony\Component\HttpKernel\KernelEvents;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. use Sensio\Bundle\FrameworkExtraBundle\Configuration\ConfigurationInterface;
  19. use Doctrine\Common\Util\ClassUtils;
  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.     protected $reader;
  34.     /**
  35.      * Constructor.
  36.      *
  37.      * @param Reader $reader An Reader instance
  38.      */
  39.     public function __construct(Reader $reader)
  40.     {
  41.         $this->reader = $reader;
  42.     }
  44.     /**
  45.      * Modifies the Request object to apply configuration information found in
  46.      * controllers annotations like the template to render or HTTP caching
  47.      * configuration.
  48.      *
  49.      * @param FilterControllerEvent $event A FilterControllerEvent instance
  50.      */
  51.     public function onKernelController(FilterControllerEvent $event)
  52.     {
  53.         $controller = $event->getController();
  55.         if (!is_array($controller) && method_exists($controller, '__invoke')) {
  56.             $controller = array($controller, '__invoke');
  57.         }
  59.         if (!is_array($controller)) {
  60.             return;
  61.         }
  63.         $className = class_exists('Doctrine\Common\Util\ClassUtils') ? ClassUtils::getClass($controller[0]) : get_class($controller[0]);
  64.         $object = new \ReflectionClass($className);
  65.         $method = $object->getMethod($controller[1]);
  67.         $classConfigurations = $this->getConfigurations($this->reader->getClassAnnotations($object));
  68.         $methodConfigurations = $this->getConfigurations($this->reader->getMethodAnnotations($method));
  70.         $configurations = array();
  71.         foreach (array_merge(array_keys($classConfigurations), array_keys($methodConfigurations)) as $key) {
  72.             if (!array_key_exists($key, $classConfigurations)) {
  73.                 $configurations[$key] = $methodConfigurations[$key];
  74.             } elseif (!array_key_exists($key, $methodConfigurations)) {
  75.                 $configurations[$key] = $classConfigurations[$key];
  76.             } else {
  77.                 if (is_array($classConfigurations[$key])) {
  78.                     if (!is_array($methodConfigurations[$key])) {
  79.                         throw new \UnexpectedValueException('Configurations should both be an array or both not be an array');
  80.                     }
  81.                     $configurations[$key] = array_merge($classConfigurations[$key], $methodConfigurations[$key]);
  82.                 } else {
  83.                     // method configuration overrides class configuration
  84.                     $configurations[$key] = $methodConfigurations[$key];
  85.                 }
  86.             }
  87.         }
  89.         $request = $event->getRequest();
  90.         foreach ($configurations as $key => $attributes) {
  91.             $request->attributes->set($key, $attributes);
  92.         }
  93.     }
  95.     protected function getConfigurations(array $annotations)
  96.     {
  97.         $configurations = array();
  98.         foreach ($annotations as $configuration) {
  99.             if ($configuration instanceof ConfigurationInterface) {
  100.                 if ($configuration->allowArray()) {
  101.                     $configurations['_'.$configuration->getAliasName()][] = $configuration;
  102.                 } elseif (!isset($configurations['_'.$configuration->getAliasName()])) {
  103.                     $configurations['_'.$configuration->getAliasName()] = $configuration;
  104.                 } else {
  105.                     throw new \LogicException(sprintf('Multiple "%s" annotations are not allowed.', $configuration->getAliasName()));
  106.                 }
  107.             }
  108.         }
  110.         return $configurations;
  111.     }
  113.     public static function getSubscribedEvents()
  114.     {
  115.         return array(
  116.             KernelEvents::CONTROLLER => 'onKernelController',
  117.         );
  118.     }
  119. }