vendor/symfony/framework-bundle/HttpCache/HttpCache.php line 63

  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\Bundle\FrameworkBundle\HttpCache;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\Response;
  16. use Symfony\Component\HttpKernel\HttpCache\Esi;
  17. use Symfony\Component\HttpKernel\HttpCache\HttpCache as BaseHttpCache;
  18. use Symfony\Component\HttpKernel\HttpCache\Store;
  19. use Symfony\Component\HttpKernel\HttpCache\StoreInterface;
  20. use Symfony\Component\HttpKernel\HttpCache\SurrogateInterface;
  21. use Symfony\Component\HttpKernel\KernelInterface;
  23. /**
  24.  * Manages HTTP cache objects in a Container.
  25.  *
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  */
  28. class HttpCache extends BaseHttpCache
  29. {
  30.     protected $cacheDir;
  31.     protected $kernel;
  33.     private ?StoreInterface $store = null;
  34.     private ?SurrogateInterface $surrogate;
  35.     private array $options;
  37.     /**
  38.      * @param $cache The cache directory (default used if null) or the storage instance
  39.      */
  40.     public function __construct(KernelInterface $kernel, string|StoreInterface $cache = null, SurrogateInterface $surrogate = null, array $options = null)
  41.     {
  42.         $this->kernel = $kernel;
  43.         $this->surrogate = $surrogate;
  44.         $this->options = $options ?? [];
  46.         if ($cache instanceof StoreInterface) {
  47.             $this->store = $cache;
  48.         } else {
  49.             $this->cacheDir = $cache;
  50.         }
  52.         if (null === $options && $kernel->isDebug()) {
  53.             $this->options = ['debug' => true];
  54.         }
  56.         if ($this->options['debug'] ?? false) {
  57.             $this->options += ['stale_if_error' => 0];
  58.         }
  60.         parent::__construct($kernel, $this->createStore(), $this->createSurrogate(), array_merge($this->options, $this->getOptions()));
  61.     }
  63.     protected function forward(Request $request, bool $catch = false, Response $entry = null): Response
  64.     {
  65.         $this->getKernel()->boot();
  66.         $this->getKernel()->getContainer()->set('cache', $this);
  68.         return parent::forward($request, $catch, $entry);
  69.     }
  71.     /**
  72.      * Returns an array of options to customize the Cache configuration.
  73.      */
  74.     protected function getOptions(): array
  75.     {
  76.         return [];
  77.     }
  79.     protected function createSurrogate(): SurrogateInterface
  80.     {
  81.         return $this->surrogate ?? new Esi();
  82.     }
  84.     protected function createStore(): StoreInterface
  85.     {
  86.         return $this->store ?? new Store($this->cacheDir ?: $this->kernel->getCacheDir().'/http_cache');
  87.     }
  88. }