vendor/symfony/http-kernel/EventListener/SurrogateListener.php line 39

  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 Symfony\Component\HttpKernel\EventListener;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  16. use Symfony\Component\HttpKernel\HttpCache\HttpCache;
  17. use Symfony\Component\HttpKernel\HttpCache\SurrogateInterface;
  18. use Symfony\Component\HttpKernel\KernelEvents;
  20. /**
  21.  * SurrogateListener adds a Surrogate-Control HTTP header when the Response needs to be parsed for Surrogates.
  22.  *
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  *
  25.  * @final
  26.  */
  27. class SurrogateListener implements EventSubscriberInterface
  28. {
  29.     private ?SurrogateInterface $surrogate;
  31.     public function __construct(SurrogateInterface $surrogate = null)
  32.     {
  33.         $this->surrogate = $surrogate;
  34.     }
  36.     /**
  37.      * Filters the Response.
  38.      */
  39.     public function onKernelResponse(ResponseEvent $event)
  40.     {
  41.         if (!$event->isMainRequest()) {
  42.             return;
  43.         }
  45.         $kernel = $event->getKernel();
  46.         $surrogate = $this->surrogate;
  47.         if ($kernel instanceof HttpCache) {
  48.             $surrogate = $kernel->getSurrogate();
  49.             if (null !== $this->surrogate && $this->surrogate->getName() !== $surrogate->getName()) {
  50.                 $surrogate = $this->surrogate;
  51.             }
  52.         }
  54.         if (null === $surrogate) {
  55.             return;
  56.         }
  58.         $surrogate->addSurrogateControl($event->getResponse());
  59.     }
  61.     public static function getSubscribedEvents(): array
  62.     {
  63.         return [
  64.             KernelEvents::RESPONSE => 'onKernelResponse',
  65.         ];
  66.     }
  67. }