vendor/api-platform/core/src/Hydra/EventListener/AddLinkHeaderListener.php line 41

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\Hydra\EventListener;
  16. use ApiPlatform\Api\UrlGeneratorInterface as LegacyUrlGeneratorInterface;
  17. use ApiPlatform\JsonLd\ContextBuilder;
  18. use ApiPlatform\Metadata\UrlGeneratorInterface;
  19. use ApiPlatform\State\Util\CorsTrait;
  20. use Psr\Link\EvolvableLinkProviderInterface;
  21. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  22. use Symfony\Component\WebLink\GenericLinkProvider;
  23. use Symfony\Component\WebLink\Link;
  25. /**
  26.  * Adds the HTTP Link header pointing to the Hydra documentation.
  27.  *
  28.  * @author Kévin Dunglas <dunglas@gmail.com>
  29.  */
  30. final class AddLinkHeaderListener
  31. {
  32.     use CorsTrait;
  34.     public function __construct(private readonly UrlGeneratorInterface|LegacyUrlGeneratorInterface $urlGenerator)
  35.     {
  36.     }
  38.     /**
  39.      * Sends the Hydra header on each response.
  40.      */
  41.     public function onKernelResponse(ResponseEvent $event): void
  42.     {
  43.         $request = $event->getRequest();
  44.         if (($operation = $request->attributes->get('_api_operation')) && 'api_platform.symfony.main_controller' === $operation->getController()) {
  45.             return;
  46.         }
  48.         // Prevent issues with NelmioCorsBundle
  49.         if ($this->isPreflightRequest($request)) {
  50.             return;
  51.         }
  53.         $apiDocUrl = $this->urlGenerator->generate('api_doc', ['_format' => 'jsonld'], UrlGeneratorInterface::ABS_URL);
  54.         $apiDocLink = new Link(ContextBuilder::HYDRA_NS.'apiDocumentation', $apiDocUrl);
  55.         $linkProvider = $request->attributes->get('_api_platform_links', new GenericLinkProvider());
  57.         if (!$linkProvider instanceof EvolvableLinkProviderInterface) {
  58.             return;
  59.         }
  61.         foreach ($linkProvider->getLinks() as $link) {
  62.             if ($link->getHref() === $apiDocUrl) {
  63.                 return;
  64.             }
  65.         }
  67.         $request->attributes->set('_api_platform_links', $linkProvider->withLink($apiDocLink));
  68.     }
  69. }