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

  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;
  17. use ApiPlatform\JsonLd\ContextBuilder;
  18. use ApiPlatform\Util\CorsTrait;
  19. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  20. use Symfony\Component\WebLink\GenericLinkProvider;
  21. use Symfony\Component\WebLink\Link;
  23. /**
  24.  * Adds the HTTP Link header pointing to the Hydra documentation.
  25.  *
  26.  * @author Kévin Dunglas <dunglas@gmail.com>
  27.  */
  28. final class AddLinkHeaderListener
  29. {
  30.     use CorsTrait;
  32.     public function __construct(private readonly UrlGeneratorInterface $urlGenerator)
  33.     {
  34.     }
  36.     /**
  37.      * Sends the Hydra header on each response.
  38.      */
  39.     public function onKernelResponse(ResponseEvent $event): void
  40.     {
  41.         $request = $event->getRequest();
  42.         // Prevent issues with NelmioCorsBundle
  43.         if ($this->isPreflightRequest($request)) {
  44.             return;
  45.         }
  47.         $apiDocUrl = $this->urlGenerator->generate('api_doc', ['_format' => 'jsonld'], UrlGeneratorInterface::ABS_URL);
  48.         $link = new Link(ContextBuilder::HYDRA_NS.'apiDocumentation', $apiDocUrl);
  50.         if (null === $linkProvider = $request->attributes->get('_links')) {
  51.             $request->attributes->set('_links', new GenericLinkProvider([$link]));
  53.             return;
  54.         }
  55.         $request->attributes->set('_links', $linkProvider->withLink($link));
  56.     }
  57. }