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

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\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  17. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  18. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  19. use ApiPlatform\Util\RequestAttributesExtractor;
  20. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  22. /**
  23.  * Configures cache HTTP headers for the current response.
  24.  *
  25.  * @author Kévin Dunglas <dunglas@gmail.com>
  26.  */
  27. final class AddHeadersListener
  28. {
  29.     use OperationRequestInitiatorTrait;
  31.     private $etag;
  32.     private $maxAge;
  33.     private $sharedMaxAge;
  34.     private $vary;
  35.     private $public;
  36.     private $resourceMetadataFactory;
  37.     private $staleWhileRevalidate;
  38.     private $staleIfError;
  40.     /**
  41.      * @param ResourceMetadataFactoryInterface|ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory
  42.      */
  43.     public function __construct(bool $etag = false, int $maxAge = null, int $sharedMaxAge = null, array $vary = null, bool $public = null, $resourceMetadataFactory = null, int $staleWhileRevalidate = null, int $staleIfError = null)
  44.     {
  45.         $this->etag = $etag;
  46.         $this->maxAge = $maxAge;
  47.         $this->sharedMaxAge = $sharedMaxAge;
  48.         $this->vary = $vary;
  49.         $this->public = $public;
  50.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  51.         $this->staleWhileRevalidate = $staleWhileRevalidate;
  52.         $this->staleIfError = $staleIfError;
  53.     }
  55.     public function onKernelResponse(ResponseEvent $event): void
  56.     {
  57.         $request = $event->getRequest();
  58.         if (!$request->isMethodCacheable()) {
  59.             return;
  60.         }
  62.         $attributes = RequestAttributesExtractor::extractAttributes($request);
  63.         if (\count($attributes) < 1) {
  64.             return;
  65.         }
  67.         $response = $event->getResponse();
  69.         if (!$response->getContent() || !$response->isSuccessful()) {
  70.             return;
  71.         }
  73.         $operation = $this->initializeOperation($request);
  74.         $resourceCacheHeaders = $attributes['cache_headers'] ?? [];
  76.         if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  77.             $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
  78.             $resourceCacheHeaders = $resourceMetadata->getOperationAttribute($attributes, 'cache_headers', [], true);
  79.         } elseif ($operation) {
  80.             $resourceCacheHeaders = $operation->getCacheHeaders();
  81.         }
  83.         if ($this->etag && !$response->getEtag()) {
  84.             $response->setEtag(md5((string) $response->getContent()));
  85.         }
  87.         if (null !== ($maxAge = $resourceCacheHeaders['max_age'] ?? $this->maxAge) && !$response->headers->hasCacheControlDirective('max-age')) {
  88.             $response->setMaxAge($maxAge);
  89.         }
  91.         $vary = $resourceCacheHeaders['vary'] ?? $this->vary;
  92.         if (null !== $vary) {
  93.             $response->setVary(array_diff($vary, $response->getVary()), false);
  94.         }
  96.         // if the public-property is defined and not yet set; apply it to the response
  97.         $public = ($resourceCacheHeaders['public'] ?? $this->public);
  98.         if (null !== $public && !$response->headers->hasCacheControlDirective('public')) {
  99.             $public ? $response->setPublic() : $response->setPrivate();
  100.         }
  102.         // Cache-Control "s-maxage" is only relevant is resource is not marked as "private"
  103.         if (false !== $public && null !== ($sharedMaxAge = $resourceCacheHeaders['shared_max_age'] ?? $this->sharedMaxAge) && !$response->headers->hasCacheControlDirective('s-maxage')) {
  104.             $response->setSharedMaxAge($sharedMaxAge);
  105.         }
  107.         if (null !== ($staleWhileRevalidate = $resourceCacheHeaders['stale_while_revalidate'] ?? $this->staleWhileRevalidate) && !$response->headers->hasCacheControlDirective('stale-while-revalidate')) {
  108.             $response->headers->addCacheControlDirective('stale-while-revalidate', (string) $staleWhileRevalidate);
  109.         }
  111.         if (null !== ($staleIfError = $resourceCacheHeaders['stale_if_error'] ?? $this->staleIfError) && !$response->headers->hasCacheControlDirective('stale-if-error')) {
  112.             $response->headers->addCacheControlDirective('stale-if-error', (string) $staleIfError);
  113.         }
  114.     }
  115. }
  117. class_alias(AddHeadersListener::class, \ApiPlatform\Core\HttpCache\EventListener\AddHeadersListener::class);