vendor/ibexa/http-cache/src/lib/EventSubscriber/UserContextSubscriber.php line 48

Open in your IDE?
  1. <?php
  3. /**
  4.  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5.  * @license For full copyright and license information view LICENSE file distributed with this source code.
  6.  */
  7. namespace Ibexa\HttpCache\EventSubscriber;
  9. use FOS\HttpCache\TagHeaderFormatter\TagHeaderFormatter;
  10. use Ibexa\HttpCache\RepositoryTagPrefix;
  11. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  12. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  13. use Symfony\Component\HttpKernel\KernelEvents;
  15. /**
  16.  * Tag /_fos_user_context_hash responses, so we can expire/clear it by tag.
  17.  */
  18. class UserContextSubscriber implements EventSubscriberInterface
  19. {
  20.     /**
  21.      * @var \Ibexa\HttpCache\RepositoryTagPrefix
  22.      */
  23.     private $prefixService;
  25.     /**
  26.      * @var string
  27.      */
  28.     private $tagHeader;
  30.     public function __construct(
  31.         RepositoryTagPrefix $prefixService,
  32.         string $tagHeader = TagHeaderFormatter::DEFAULT_HEADER_NAME
  33.     ) {
  34.         $this->prefixService = $prefixService;
  35.         $this->tagHeader = $tagHeader;
  36.     }
  38.     public static function getSubscribedEvents()
  39.     {
  40.         return [KernelEvents::RESPONSE => ['tagUserContext', 10]];
  41.     }
  43.     /**
  44.      * Tag vnd.fos.user-context-hash responses if they are set to cached.
  45.      *
  46.      * @param \Symfony\Component\HttpKernel\Event\ResponseEvent $event
  47.      */
  48.     public function tagUserContext(ResponseEvent $event)
  49.     {
  50.         $response = $event->getResponse();
  51.         if (!$response->isCacheable()) {
  52.             return;
  53.         }
  55.         if ($response->headers->get('Content-Type') !== 'application/vnd.fos.user-context-hash') {
  56.             return;
  57.         }
  59.         if (!$response->getTtl()) {
  60.             return;
  61.         }
  63.         // We need to set tag directly on response here to make sure this does not also get applied to the main request
  64.         // when using Symfony Proxy, as tag handler does not clear tags between requests.
  65.         // NB: We prefix this even if route is not SA aware, but this is the same as with REST. As doc states,
  66.         // it's expected that each repo needs to have own domain so requests against base domain represent same repo.
  67.         $response->headers->set($this->tagHeader, $this->prefixService->getRepositoryPrefix() . 'ez-user-context-hash');
  68.     }
  69. }
  71. class_alias(UserContextSubscriber::class, 'EzSystems\PlatformHttpCacheBundle\EventSubscriber\UserContextSubscriber');