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

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\Core\HttpCache\EventListener;
  16. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  17. use ApiPlatform\Core\Util\RequestAttributesExtractor;
  18. use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
  20. /**
  21.  * Configures cache HTTP headers for the current response.
  22.  *
  23.  * @author Kévin Dunglas <dunglas@gmail.com>
  24.  *
  25.  * @experimental
  26.  */
  27. final class AddHeadersListener
  28. {
  29.     private $etag;
  30.     private $maxAge;
  31.     private $sharedMaxAge;
  32.     private $vary;
  33.     private $public;
  34.     private $resourceMetadataFactory;
  36.     public function __construct(bool $etag = false, int $maxAge = null, int $sharedMaxAge = null, array $vary = null, bool $public = null, ResourceMetadataFactoryInterface $resourceMetadataFactory = null)
  37.     {
  38.         $this->etag = $etag;
  39.         $this->maxAge = $maxAge;
  40.         $this->sharedMaxAge = $sharedMaxAge;
  41.         $this->vary = $vary;
  42.         $this->public = $public;
  43.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  44.     }
  46.     public function onKernelResponse(FilterResponseEvent $event): void
  47.     {
  48.         $request = $event->getRequest();
  49.         if (!$request->isMethodCacheable() || !RequestAttributesExtractor::extractAttributes($request)) {
  50.             return;
  51.         }
  53.         $response = $event->getResponse();
  55.         if (!$response->getContent() || !$response->isSuccessful()) {
  56.             return;
  57.         }
  59.         $resourceCacheHeaders = [];
  60.         if ($this->resourceMetadataFactory && $attributes = RequestAttributesExtractor::extractAttributes($request)) {
  61.             $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
  62.             $resourceCacheHeaders = $resourceMetadata->getOperationAttribute($attributes, 'cache_headers', [], true);
  63.         }
  65.         if ($this->etag && !$response->getEtag()) {
  66.             $response->setEtag(md5((string) $response->getContent()));
  67.         }
  69.         if (null !== ($maxAge = $resourceCacheHeaders['max_age'] ?? $this->maxAge) && !$response->headers->hasCacheControlDirective('max-age')) {
  70.             $response->setMaxAge($maxAge);
  71.         }
  73.         if (null !== $this->vary) {
  74.             $response->setVary(array_diff($this->vary, $response->getVary()), false);
  75.         }
  77.         if (null !== ($sharedMaxAge = $resourceCacheHeaders['shared_max_age'] ?? $this->sharedMaxAge) && !$response->headers->hasCacheControlDirective('s-maxage')) {
  78.             $response->setSharedMaxAge($sharedMaxAge);
  79.         }
  81.         if (null !== $this->public && !$response->headers->hasCacheControlDirective('public')) {
  82.             $this->public ? $response->setPublic() : $response->setPrivate();
  83.         }
  84.     }
  85. }