vendor/api-platform/core/src/Symfony/EventListener/AddLinkHeaderListener.php line 50

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\Symfony\EventListener;
  16. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  17. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  18. use ApiPlatform\Util\CorsTrait;
  19. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  20. use ApiPlatform\Util\RequestAttributesExtractor;
  21. use Fig\Link\GenericLinkProvider;
  22. use Fig\Link\Link;
  23. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  24. use Symfony\Component\Mercure\Discovery;
  26. /**
  27.  * Adds the HTTP Link header pointing to the Mercure hub for resources having their updates dispatched.
  28.  *
  29.  * @author Kévin Dunglas <dunglas@gmail.com>
  30.  */
  31. final class AddLinkHeaderListener
  32. {
  33.     use CorsTrait;
  34.     use OperationRequestInitiatorTrait;
  36.     /**
  37.      * @var ResourceMetadataCollectionFactoryInterface|ResourceMetadataFactoryInterface
  38.      */
  39.     private $resourceMetadataFactory;
  40.     private $discovery;
  42.     /**
  43.      * @param Discovery|string $discovery
  44.      * @param mixed            $resourceMetadataFactory
  45.      */
  46.     public function __construct($resourceMetadataFactory, $discovery)
  47.     {
  48.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  49.         if ($resourceMetadataFactory && !$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  50.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  51.         }
  53.         if ($resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  54.             $this->resourceMetadataCollectionFactory = $resourceMetadataFactory;
  55.         }
  57.         $this->discovery = $discovery;
  58.     }
  60.     /**
  61.      * Sends the Mercure header on each response.
  62.      */
  63.     public function onKernelResponse(ResponseEvent $event): void
  64.     {
  65.         $request = $event->getRequest();
  66.         if ($this->isPreflightRequest($request)) {
  67.             return;
  68.         }
  70.         $operation = $this->initializeOperation($request);
  72.         if (
  73.             null === ($resourceClass = $request->attributes->get('_api_resource_class')) ||
  74.             !($attributes = RequestAttributesExtractor::extractAttributes($request))
  75.         ) {
  76.             return;
  77.         }
  79.         $mercure = $operation ? $operation->getMercure() : ($attributes['mercure'] ?? false);
  80.         // TODO: remove in 3.0
  81.         if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  82.             $mercure = $this->resourceMetadataFactory->create($resourceClass)->getAttribute('mercure', false);
  83.         }
  85.         if (!$mercure) {
  86.             return;
  87.         }
  89.         if (!$this->discovery instanceof Discovery) {
  90.             $link = new Link('mercure', $this->discovery);
  91.             if (null === $linkProvider = $request->attributes->get('_links')) {
  92.                 $request->attributes->set('_links', new GenericLinkProvider([$link]));
  94.                 return;
  95.             }
  97.             $request->attributes->set('_links', $linkProvider->withLink($link));
  99.             return;
  100.         }
  102.         $hub = \is_array($mercure) ? ($mercure['hub'] ?? null) : null;
  104.         $this->discovery->addLink($request, $hub);
  105.     }
  106. }
  108. class_alias(AddLinkHeaderListener::class, \ApiPlatform\Core\Mercure\EventListener\AddLinkHeaderListener::class);