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

Open in your IDE?
  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 $store;
  34. private $surrogate;
  35. private $options;
  37. /**
  38. * @param string|StoreInterface $cache The cache directory (default used if null) or the storage instance
  39. */
  40. public function __construct(KernelInterface $kernel, $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. } elseif (null !== $cache && !\is_string($cache)) {
  49. throw new \TypeError(sprintf('Argument 2 passed to "%s()" must be a string or a SurrogateInterface, "%s" given.', __METHOD__, get_debug_type($cache)));
  50. } else {
  51. $this->cacheDir = $cache;
  52. }
  54. if (null === $options && $kernel->isDebug()) {
  55. $this->options = ['debug' => true];
  56. }
  58. if ($this->options['debug'] ?? false) {
  59. $this->options += ['stale_if_error' => 0];
  60. }
  62. parent::__construct($kernel, $this->createStore(), $this->createSurrogate(), array_merge($this->options, $this->getOptions()));
  63. }
  65. /**
  66. * {@inheritdoc}
  67. */
  68. protected function forward(Request $request, bool $catch = false, ?Response $entry = null)
  69. {
  70. $this->getKernel()->boot();
  71. $this->getKernel()->getContainer()->set('cache', $this);
  73. return parent::forward($request, $catch, $entry);
  74. }
  76. /**
  77. * Returns an array of options to customize the Cache configuration.
  78. *
  79. * @return array
  80. */
  81. protected function getOptions()
  82. {
  83. return [];
  84. }
  86. /**
  87. * @return SurrogateInterface
  88. */
  89. protected function createSurrogate()
  90. {
  91. return $this->surrogate ?? new Esi();
  92. }
  94. /**
  95. * @return StoreInterface
  96. */
  97. protected function createStore()
  98. {
  99. return $this->store ?? new Store($this->cacheDir ?: $this->kernel->getCacheDir().'/http_cache');
  100. }
  101. }