vendor/api-platform/core/src/HttpCache/EventListener/AddHeadersListener.php line 37

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.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. declare(strict_types=1);
  14. namespace ApiPlatform\HttpCache\EventListener;
  16. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  17. use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
  18. use ApiPlatform\Symfony\Util\RequestAttributesExtractor;
  19. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  21. /**
  22.  * Configures cache HTTP headers for the current response.
  23.  *
  24.  * @author Kévin Dunglas <dunglas@gmail.com>
  25.  *
  26.  * @deprecated use \Symfony\EventListener\AddHeadersListener.php instead
  27.  */
  28. final class AddHeadersListener
  29. {
  30.     use OperationRequestInitiatorTrait;
  32.     public function __construct(private readonly bool $etag = false, private readonly ?int $maxAge = null, private readonly ?int $sharedMaxAge = null, private readonly ?array $vary = null, private readonly ?bool $public = null, ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, private readonly ?int $staleWhileRevalidate = null, private readonly ?int $staleIfError = null)
  33.     {
  34.         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
  35.     }
  37.     public function onKernelResponse(ResponseEvent $event): void
  38.     {
  39.         $request = $event->getRequest();
  40.         if (!$request->isMethodCacheable()) {
  41.             return;
  42.         }
  44.         $attributes = RequestAttributesExtractor::extractAttributes($request);
  45.         if (\count($attributes) < 1) {
  46.             return;
  47.         }
  49.         $response = $event->getResponse();
  51.         if (!$response->getContent() || !$response->isSuccessful()) {
  52.             return;
  53.         }
  55.         $operation = $this->initializeOperation($request);
  56.         if ('api_platform.symfony.main_controller' === $operation?->getController()) {
  57.             return;
  58.         }
  59.         $resourceCacheHeaders = $attributes['cache_headers'] ?? $operation?->getCacheHeaders() ?? [];
  61.         if ($this->etag && !$response->getEtag()) {
  62.             $response->setEtag(md5((string) $response->getContent()));
  63.         }
  65.         if (null !== ($maxAge = $resourceCacheHeaders['max_age'] ?? $this->maxAge) && !$response->headers->hasCacheControlDirective('max-age')) {
  66.             $response->setMaxAge($maxAge);
  67.         }
  69.         $vary = $resourceCacheHeaders['vary'] ?? $this->vary;
  70.         if (null !== $vary) {
  71.             $response->setVary(array_diff($vary, $response->getVary()), false);
  72.         }
  74.         // if the public-property is defined and not yet set; apply it to the response
  75.         $public = ($resourceCacheHeaders['public'] ?? $this->public);
  76.         if (null !== $public && !$response->headers->hasCacheControlDirective('public')) {
  77.             $public ? $response->setPublic() : $response->setPrivate();
  78.         }
  80.         // Cache-Control "s-maxage" is only relevant is resource is not marked as "private"
  81.         if (false !== $public && null !== ($sharedMaxAge = $resourceCacheHeaders['shared_max_age'] ?? $this->sharedMaxAge) && !$response->headers->hasCacheControlDirective('s-maxage')) {
  82.             $response->setSharedMaxAge($sharedMaxAge);
  83.         }
  85.         if (null !== ($staleWhileRevalidate = $resourceCacheHeaders['stale_while_revalidate'] ?? $this->staleWhileRevalidate) && !$response->headers->hasCacheControlDirective('stale-while-revalidate')) {
  86.             $response->headers->addCacheControlDirective('stale-while-revalidate', (string) $staleWhileRevalidate);
  87.         }
  89.         if (null !== ($staleIfError = $resourceCacheHeaders['stale_if_error'] ?? $this->staleIfError) && !$response->headers->hasCacheControlDirective('stale-if-error')) {
  90.             $response->headers->addCacheControlDirective('stale-if-error', (string) $staleIfError);
  91.         }
  92.     }
  93. }