vendor/sulu/sulu/src/Sulu/Bundle/HttpCacheBundle/Cache/SuluHttpCache.php line 84

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  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 Sulu\Bundle\HttpCacheBundle\Cache;
  14. use FOS\HttpCache\SymfonyCache\CacheInvalidation;
  15. use FOS\HttpCache\SymfonyCache\CleanupCacheTagsListener;
  16. use FOS\HttpCache\SymfonyCache\CustomTtlListener;
  17. use FOS\HttpCache\SymfonyCache\DebugListener;
  18. use FOS\HttpCache\SymfonyCache\EventDispatchingHttpCache;
  19. use FOS\HttpCache\SymfonyCache\PurgeListener;
  20. use FOS\HttpCache\SymfonyCache\PurgeTagsListener;
  21. use FOS\HttpCache\TagHeaderFormatter\TagHeaderFormatter;
  22. use Sulu\Bundle\WebsiteBundle\EventListener\SegmentCacheListener;
  23. use Sulu\Component\HttpKernel\SuluKernel;
  24. use Symfony\Bundle\FrameworkBundle\HttpCache\HttpCache;
  25. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  26. use Symfony\Component\HttpFoundation\Request;
  27. use Symfony\Component\HttpFoundation\Response;
  28. use Symfony\Component\HttpKernel\HttpCache\StoreInterface;
  29. use Symfony\Component\HttpKernel\HttpKernelInterface;
  30. use Toflar\Psr6HttpCacheStore\Psr6Store;
  32. /**
  33.  * Abstract class to extend from when using Symfony cache.
  34.  * Add needed subscriber in the constructor.
  35.  */
  36. class SuluHttpCache extends HttpCache implements CacheInvalidation
  37. {
  38.     use EventDispatchingHttpCache;
  40.     public const HEADER_REVERSE_PROXY_TTL = 'X-Reverse-Proxy-TTL';
  42.     /**
  43.      * @param string $cacheDir
  44.      */
  45.     public function __construct(HttpKernelInterface $kernel, $cacheDir = null)
  46.     {
  47.         if (!$cacheDir && $kernel instanceof SuluKernel) {
  48.             $cacheDir = $kernel->getCommonCacheDir() . \DIRECTORY_SEPARATOR . 'http_cache';
  49.         }
  51.         parent::__construct($kernel, $cacheDir);
  53.         foreach ($this->getSubscribers() as $subscriber) {
  54.             $this->addSubscriber($subscriber);
  55.         }
  56.     }
  58.     /**
  59.      * @return EventSubscriberInterface[]
  60.      */
  61.     protected function getSubscribers(): array
  62.     {
  63.         $subscribers = [
  64.             CustomTtlListener::class => new CustomTtlListener(static::HEADER_REVERSE_PROXY_TTL),
  65.             PurgeListener::class => new PurgeListener(),
  66.             PurgeTagsListener::class => new PurgeTagsListener(),
  67.             SegmentCacheListener::class => new SegmentCacheListener(),
  68.         ];
  70.         if ($this->kernel->isDebug()) {
  71.             $subscribers[DebugListener::class] = new DebugListener();
  72.         } else {
  73.             $subscribers[CleanupCacheTagsListener::class] = new CleanupCacheTagsListener();
  74.         }
  76.         return $subscribers;
  77.     }
  79.     /**
  80.      * Made public to allow event listeners to do refresh operations.
  81.      *
  82.      * {@inheritdoc}
  83.      */
  84.     public function fetch(Request $request, $catch = false): Response
  85.     {
  86.         return parent::fetch($request, $catch);
  87.     }
  89.     protected function createStore(): StoreInterface
  90.     {
  91.         return new Psr6Store([
  92.             'cache_directory' => $this->cacheDir,
  93.             'cache_tags_header' => TagHeaderFormatter::DEFAULT_HEADER_NAME,
  94.         ]);
  95.     }
  96. }